orderInformation

The following fields provide order information.

orderInformation. amountDetails.amexAdditionalAmounts[N]. amount

Additional amount.
This field is available only on the
American Express Direct
processor.
Array
of fields from
orderInformation.amountDetails.amexAdditionalAmounts[0].amount
to
orderInformation.amountDetails.amexAdditionalAmounts[4].amount
.

Specifications

  • Data Type:
    String
  • Data Length:
    12

Mapping Information

  • REST API Fields:
    orderInformation.amountDetails.amexAdditionalAmounts[0].amount
    through
    orderInformation.amountDetails.amexAdditionalAmounts[4].amount
  • SCMP API Fields:
    additional_amount0
    through
    additional_amount4
  • Simple Order API Fields:
    purchaseTotals_additionalAmount0
    through
    purchaseTotals_additionalAmount4

orderInformation. amountDetails.amexAdditionalAmounts[N]. code

Additional amount type.
This field is available only on the
American Express Direct
processor.
Array
of fields from
orderInformation.amountDetails.amexAdditionalAmounts[0].code
to
orderInformation.amountDetails.amexAdditionalAmounts[4].code
.
For the possible values, see Additional Amount Types.

Specifications

  • Data Type:
    String
  • Data Length:
    3

Mapping Information

  • REST API Fields:
    orderInformation.amountDetails.amexAdditionalAmounts[0].code
    through
    orderInformation.amountDetails.amexAdditionalAmounts[4].code
  • SCMP API Fields:
    additional_amount_type0
    through
    additional_amount_type4
  • Simple Order API Fields:
    purchaseTotals_additionalAmountType0
    through
    purchaseTotals_additionalAmountType4

orderInformation. amountDetails.anticipatedAmount

The amount that is expected to be charged in the transaction.
Visa Platform Connect
This field is required for zero amount authorizations in order to confirm the amount is available for future authorizations.

Specifications

  • Data Type:
    Numeric
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.anticipatedAmount
  • SCMP API Field:
    anticipated_amount
  • Simple Order API Field:
    purchaseTotals_anticipatedAmount

orderInformation. amountDetails.authorizedAmount

Amount of the purchase.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.authorizedAmount
  • SCMP API Fields:
    • auth_auth_amount
    • incremental_auth_amount
    • pin_debit_purchase_auth_amount
  • Simple Order API Fields:
    • ccAuthReply_amount
    • ccIncrementalAuthReply_amount
    • pinDebitPurchaseReply_amount

orderInformation. amountDetails.billingAmount

Amount charged during the billing period.

Specifications

  • Data Type:
    String
  • Data Length:
    19

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.billingAmount
  • SCMP API Field:
    No corresponding field.
  • Simple Order API Field:
    No corresponding field.

orderInformation. amountDetails.cashbackAmount

Cashback amount requested by the customer.
The value for this field must be in the acquirer’s currency.
Card-Present Credit Card Transactions
This field is available only on the
Visa Platform Connect
processor in Germany.
The value for this field corresponds to this data in the TC 33 capture file:
  • Record: CP01 TCR8
  • Position: 15-23
  • Field: Cashback Amount
The TC 33 capture file contains information about the payments and credits that a merchant submits to
Cybersource
. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.
PIN Debit Transactions
This field is available only on the
FDC Nashville Global
and
Visa Platform Connect
processors.
When a cashback amount is included in a request, the cashback amount must be included in the value for the
orderInformation.amountDetails.totalAmount
field.

Specifications

  • Data Type:
    String
  • Data Length:
    • Authorization: 9
    • Authorization Reversal: 9
    • PIN Debit Purchase: 13

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.cashbackAmount
  • SCMP API Field:
    cashback_amount
  • Simple Order API Field:
    cashbackAmount

orderInformation. amountDetails.currencyConversion. indicator

Enables Dynamic Currency Conversion during an authorization.
Available values:
  • N
    : Not enabled (default)
  • Y
    : Enabled

Syntax

This syntax is used with this field:
{ "currencyConversion": { "indicator": "Y" } }

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    orderInformation.amountdetails.currencyConversion.indicator
  • SCMP API Field:
    dcc_indicator
  • Simple Order API Field:
    dcc_dccIndicator

orderInformation. amountDetails.currency

Currency used in the transaction.
Use a three-character ISO currency code. For a list of ISO currency codes, see ISO Standard Currency Codes.
For authorization reversal or capture services, you must use the same currency that was used for the authorization.
For the PIN debit reversal service, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.
When using Dynamic Currency Conversion (DCC) with a Third-Party Provider, use the customer’s billing currency.
Visa Platform Connect
For Mastercard installment payments in Peru, the value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR5
  • Position: 108-110
  • Field: Financing Currency

Specifications

  • Data Type:
    String
  • Data Length:
    3

Mapping Information

  • REST API Fields:
    • orderInformation.amountDetails.currency
    • creditAmountDetails.currency
    • refundAmountDetails.currency
    • reversalAmountDetails.currency
    • reversalInformation.amountDetails.currency
  • SCMP API Fields:
    • auth_request_currency
    • currency
    • pin_debit_purchase_request_currency
  • Simple Order API Fields:
    • ccAuthReply_requestCurrency
    • pinDebitPurchaseReply_requestCurrency
    • purchaseTotals_currency

orderInformation. amountDetails.discountAmount

The total discount applied to the order.
Example: A $20.00 discount off the order total.
RBS WorldPay Atlanta
:
The discount amount cannot exceed 999999.99.

Specifications

  • Data Type:
    • Chase Paymentech Solutions
      ,
      FDC Compass
      ,
      TSYS Acquiring Solutions
      ,
      FDC Nashville Global
      ,
      RBS WorldPay Atlanta
      and
      Worldpay VAP
      : String
    • Elavon Americas
      GPN
      OmniPay Direct
      and
      Visa Platform Connect
      : Numeric String
  • Data Length:
    • Chase Paymentech Solutions
      ,
      FDC Compass
      , and
      TSYS Acquiring Solutions
      :13
    • FDC Nashville Global
      : 11
    • RBS WorldPay Atlanta
      and
      Worldpay VAP
      : 8
    • Elavon Americas
      ,
      GPN
      ,
      OmniPay Direct
      , and
      Visa Platform Connect
      : 12

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.discountAmount
  • SCMP API Field:
    order_discount_amount
  • Simple Order API Field:
    purchaseTotals_discountAmount

Processor Field Names

Processor-specific field names for each processor supporting this field for Level II or Level III processing:
  • Chase Paymentech Solutions
    :
    Discount Amount Applied to Order
  • Elavon Americas
    :
    Discount Amount
  • FDC Compass
    :
    Discount Amount Applied to Order
  • FDC Nashville Global
    :
    Discount Amount
  • GPN
    :
    Discount Amount
  • OmniPay Direct
    :
    Discount Amount / Total Discount
  • RBS WorldPay Atlanta
    :
    Discount Amount
  • TSYS Acquiring Solutions
    :
    Discount Amount
  • Visa Platform Connect
    :
    discountAmount
  • Worldpay VAP
    :
    discountAmount

orderInformation. amountDetails. discountPercent

The total discount percentage applied to the invoice.

Specifications

  • Data Type:
    Number
  • Data Length:
    7

Mapping

  • REST Field Name:
    orderInformation.amountDetails.discountPercent
  • Simple Order Field Name:
    No corresponding field.

orderInformation. amountDetails.dutyAmount

Total charges for any import or export duties included in the order.
FDC Nashville Global
This value cannot be negative.
FDMS South
This value cannot be negative.
GPN
The maximum value for this field is: 99,999.99.

Specifications

  • Data Length:
    • Chase Paymentech Solutions
      ,
      FDC Compass
      :
      • Mastercard: 10
      • Visa: 13
    • Elavon Americas
      ,
      GPN
      ,
      OmniPay Direct
      ,
      Visa Platform Connect
      : 12
    • FDC Nashville Global
      : 11
    • FDMS South
      : 15
    • RBS WorldPay Atlanta
      and
      Worldpay VAP
      : 8
    • TSYS Acquiring Solutions
      : 13

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.dutyAmount
  • SCMP API Field:
    duty_amount
  • Simple Order API Field:
    purchaseTotals_dutyAmount

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:
  • Chase Paymentech Solutions
    : Duty Amount
  • Elavon Americas
    : Duty Amount
  • FDC Compass
    : Duty Amount
  • FDC Nashville Global
    : Duty Amount
  • FDMS South
    : Does not apply
  • GPN
    : Duty Amount
  • OmniPay Direct
    : Duty Amount
  • RBS WorldPay Atlanta
    : Duty Amount
  • TSYS Acquiring Solutions
    : Duty Amount
  • Visa Platform Connect
    : dutyAmount
  • Worldpay VAP
    : dutyAmount

orderInformation. amountDetails. exchangeRate

Exchange rate returned by the Dynamic Currency Conversion (DCC) service provider.
The value for this field includes a decimal point and a maximum of four decimal places.

Specifications

  • Data Type:
    String
  • Data Length:
    13

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.exchangeRate
  • SCMP API Field:
    exchange_rate
  • Simple Order API Field:
    purchaseTotals_exchangeRate

orderInformation. amountDetails. exchangeRateTimeStamp

The time stamp returned by a Dynamic Currency Conversion provider when a conversion request is made. This value is set to GMT.

Specifications

  • Data Type:
    String
  • Data Length:
    14
  • Data Format:
    yyyyMMDDhhmmss

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.exchangeRateTimeStamp
  • SCMP API Field:
    exchange_rate_timestamp
  • Simple Order API Field:
    purchaseTotals_exchangeRateTimeStamp

orderInformation. amountDetails.foreignAmount

Converted amount that was returned by the DCC provider.

Specifications

  • Data Type:
    String
  • Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.foreignAmount
  • SCMP API Field:
    foreign_amount
  • Simple Order API Field:
    purchaseTotals_foreignAmount

orderInformation. amountDetails.foreignCurrency

Customer’s billing currency.

Specifications

  • Data Type:
    String
  • Data Length:
    5

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.foreignCurrency
  • SCMP API Field:
    foreign_currency
  • Simple Order API Field:
    purchaseTotals_foreignCurrency

orderInformation. amountDetails.foreignExchangeFee

Fee the issuer charges when the recipient’s currency is not the same as the sender’s currency. When this fee is charged, the grand total amount must include the fee.

Specifications

  • Data Type:
    String
  • Data Length:
    12

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.foreignExchangeFee
  • SCMP API Field:
    aft_foreign_exchange_fee
  • Simple Order API Field:
    aft_foreignExchangeFee

orderInformation. amountDetails.freightAmount

The total freight or shipping and handling charges for the order.
OmniPay Direct
For Level III transacations with Visa, the field value is set to 0 when this field is not included in the request.

Specifications

  • Data Type:
    String
  • Data Length:
    • Chase Paymentech Solutions
      :
      10 (Mastercard), 13 (Visa)
    • FDC Compass
      :
      10 (Mastercard), 13 (Visa)
    • FDC Nashville Global
      :
      13
    • RBS WorldPay Atlanta
      :
      8
    • Worldpay VAP
      :
      8
    • TSYS Acquiring Solutions
      :
      13
    • All other processors:
      12

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.freightAmount
  • SCMP API Field:
    freight_amount
  • Simple Order API Field:
    purchaseTotals_freightAmount

Processor Field Names

The following list the processors and the corresponding processor field mapped to this field:
  • Chase Paymentech Solutions
    :
    Freight Amount
  • Elavon Americas
    :
    Freight/Shipping Amount
  • FDC Compass
    :
    Freight Amount
  • FDC Nashville Global
    :
    Freight Amount
  • GPN
    :
    Freight Amount
  • OmniPay Direct
    :
    Freight Amount / Shipping Amount
  • RBS WorldPay Atlanta
    :
    Freight Amount
  • TSYS Acquiring Solutions
    :
    Freight Amount
  • Visa Platform Connect
    :
    freightAmount
  • Worldpay VAP
    :
    shipping amount

orderInformation. amountDetails. freight.taxable

The indicator for whether or not an order is taxable.
The value must be set to
true
if the total sum of all of the values included in
orderInformation.lineItems[].taxAmount
request field are great than
0
.
Possible values:
  • false
    : The order is not taxable.
  • true
    : The order is taxable.

Specifications

  • Data Type:
    Boolean
  • Data Length:
    5

Mapping

  • REST Field Name:
    orderInformation.amountDetails.freight.taxable
  • Simple Order Field Name:
    No corresponding field.

orderInformation. amountDetails. freight. taxRate

The shipping tax rate applied to the charged freight amount.

Specifications

  • Data Type:
    String
  • Data Length:
    7

Mapping

  • REST Field Name:
    orderInformation.amountDetails.freight.taxRate
  • Simple Order Field Name:
    No corresponding field.

orderInformation. amountDetails.gratuityAmount

Gratuity or tip amount for restaurants when the card is present.
Allowed only when the
orderInformation.amountDetails.gratuityAmount
field value is
restaurant
.
Restaurant data is available only on the
Visa Platform Connect
processor.
When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount.

Specifications

  • Data Type:
    String
  • Data Length:
    12

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.gratuityAmount
  • SCMP API Field:
    gratuity_amount
  • Simple Order API Field:
    ccCaptureService_gratuityAmount

orderInformation. amountDetails. minimumPartialAmount

The minimum partial amount required to be paid for the invoice.

Specifications

  • Data Type:
    Number
  • Data Length:
    25

Mapping

  • REST Field Name:
    orderInformation.amountDetails.minimumPartialAmount
  • Simple Order Field Name:
    No corresponding field.

orderInformation. amountDetails.nationalTaxIncluded

Flag that indicates whether a national tax is included in the order total.
Possible values:
  • 0
    : national tax not included
  • 1
    : national tax included
This value must be 1 if the sum of all
orderInformation.lineItems[].taxDetails[].amount
values > 0.
If you do not include any
orderInformation.lineItems[].taxDetails[].amount
values in your request,
Cybersource
does not include in the data it sends to the processor.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.nationalTaxIncluded
  • SCMP API Field:
    national_tax_indicator
  • Simple Order API Field:
    otherTax_nationalTaxIndicator

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:
  • Elavon Americas
    : National / Alternate Tax Included
  • OmniPay Direct
    :  National Tax Included
  • TSYS Acquiring Solutions
    :  National Tax Included Flag
  • Visa Platform Connect
    : nationalTaxIncluded

orderInformation. amountDetails.originalAmount

The purchase amount denominated in the local currency, when the
orderInformation.amountDetails.totalAmount
field is denominated in the customer's billing currency.
This field is available only for the Dynamic Currency Conversion service.
This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, the amount is truncated to the correct number of decimal places.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.originalAmount
  • SCMP API Field:
    original_amount
  • Simple Order API Field:
    purchaseTotals_originalAmount

orderInformation. amountDetails.originalCurrency

The local billing currency, when the
orderInformation.amountDetails.totalCurrency
field is set the customer's billing currency.
This field is available only for the Dynamic Currency Conversion service.

Specifications

  • Data Type:
    String
  • Data Length:
    5

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.originalCurrency
  • SCMP API Field:
    original_currency
  • Simple Order API Field:
    purchaseTotals_originalCurrency

orderInformation. amountDetails.serviceFeeAmount

Fee you are charging for the transaction.
When this fee is charged, the grand total amount must include the fee.

Specifications

  • Data Type:
    String
  • Data Length:
    12

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.serviceFeeAmount
  • SCMP API Field:
    aft_service_fee
  • Simple Order API Field:
    aft_serviceFee

orderInformation. amountDetails. settlementAmount

Amount deposited into the recipient's account by the issuer.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.settlementAmount
  • SCMP API Field:
    recipient_billing_amount
  • Simple Order API Field:
    recipient_billingAmount

orderInformation. amountDetails. settlementCurrency

Currency used by the issuer to deposit the funds into the recipient’s account.
See the ISO Standard Currency Codes reference guide.

Specifications

  • Data Type:
    String
  • Data Length:
    3

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.settlementCurrency
  • SCMP API Field:
    recipient_billing_currency
  • Simple Order API Field:
    recipient_billingCurrency

orderInformation. amountDetails.setUpFee

The subscription set-up fee charged by the merchant.

Specifications

  • Data Type:
    String
  • Data Length:
    19

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.setUpFee
  • SCMP API Field:
    No corresponding field.
  • Simple Order API Field:
    No corresponding field.

orderInformation. amountDetails. subAmount

The sub-amount of the invoice.

Specifications

  • Data Type:
    Number
  • Data Length:
    25

Mapping

  • REST Field Name:
    orderInformation.amountDetails.subAmount
  • Simple Order Field Name:
    No corresponding field.

orderInformation. amountDetails.surcharge.amount

Surcharge amount that you are charging the customer for the transaction.
This field is available on the
FDC Nashville Global
,
Worldpay VAP
, and
Visa Platform Connect
processors.
The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer.
Visa Platform Connect
Canada Card-Present Transactions
Merchants in Canada must include surcharge information in authorization requests for card-present transactions.
Acquirers that have merchants in Canada must support this surcharge data in the TC 33 capture file:
  • Record: CP01 TCR8
  • Position: 13
  • Field: Surcharge credit/debit indicator
The TC 33 capture file contains information about the payments and credits that a merchant submits to
Cybersource
. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.
PIN Debit Transactions
  • Include the surcharge amount in the value for
    orderInformation.amountDetails.totalAmount
    .
FDC Nashville Global
US Credit Card Transactions
The surcharge amount can be applied to card-present and card-not-present transactions on credit cards in the US. Support includes the surcharge API calls but the specific network rules are out of scope and the merchant may be subject to non-compliance assessments if surcharging is improperly applied.
Prior Approval Required
You must receive prior approval from Fiserv before assessing a surcharge amount. Contact Fiserv to register with the card brands to participate in the surcharge program. You will be required to sign a surcharging contract or addendum with Fiserv.
Worldpay VAP
Prior Notification Required for
Worldpay VAP
The surcharge amount field can only be applied to Visa or Mastercard credit card payments. You must notify the card networks and acquirer of your intent to apply surcharges at least 30 days prior to assessing the surcharges. Contact the
Worldpay VAP
customer service manager to request the surcharge feature.
Worldpay VAP
must enable a flag to process the surcharge field, otherwise the transaction will fail.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.surcharge.amount
  • SCMP API Field:
    surcharge_amount
  • Simple Order API Field:
    surchargeAmount

orderInformation. amountDetails.taxAmount

Total tax amount for all items.
This field is available only on the
American Express Direct
and
Barclays
processors.

Specifications

  • Data Type:
    String
  • Data Length
    • Canadian dollars (CAD): 7
    • US dollars (USD): 9

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.taxAmount
  • SCMP API Field:
    total_tax_amount
  • Simple Order API Field:
    purchaseTotals_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:
  • American Express Direct
    : Does not apply

orderInformation. amountDetails.taxAppliedAfterDiscount

Flag that indicates how the merchant manages discounts.
This field is available only on the
Visa Platform Connect
processor.
Possible values:
  • 0
    : no invoice level discount included
  • 1
    : tax calculated on the post-discount invoice total
  • 2
    : tax calculated on the pre-discount invoice total
This field relates to the value in the
orderInformation.amountDetails.discountAmount
field.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.taxAppliedAfterDiscount
  • SCMP API Field:
    order_discount_management_indicator
  • Simple Order API Field:
    purchaseTotals_discountManagementIndicator

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:
  • Visa Platform Connect
    : discountManagementIndicator

orderInformation. amountDetails.taxAppliedLevel

Indicates how tax is calculated.
This field is available only on the
Visa Platform Connect
processor.
Possible values:
  • 0
    : Net prices with tax calculated at the line item level.
  • 1
    : Net prices with tax calculated at the invoice level.
  • 2
    : Gross prices with tax provided at the line item level.
  • 3
    : Gross prices with tax provided at the invoice level.
  • 4
    : No tax applied on the invoice for the transaction.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.taxAppliedLevel
  • SCMP API Field:
    tax_management_indicator
  • Simple Order API Field:
    taxManagementIndicator

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:
  • Visa Platform Connect
    : taxManagementIndicator

orderInformation. amountDetails.taxDetails[]. amount

Amount of national tax or value added tax for countries in which more than one tax is applied to an order.
Provide this value if
orderInformation.lineItems[].taxDetails[].amount
differs from
orderInformation.lineItems[].taxAmount
. If you do not provide this value,
Cybersource
assumes that
orderInformation.lineItems[].taxDetails[].amount
is equal to
orderInformation.lineItems[].taxAmount
.
RBS WorldPay Atlanta
The value of this field cannot exceed
999999.99
.
FDC Nashville Global
The total should not include the local tax amount ( field) and national tax (
national_tax
field) incluced in the total tax (
tax_amount
field).
GPN
The maximum amount is 99,999.99.
RBS WorldPay Atlanta
The maximum amount is 99,999.99.
OmniPay Direct
When you include this field in the request, you must also include the
orderInformation.lineItems[].taxAmount
field in the request.

Specifications

  • Data Type:
    String
  • Data Length:
    • Chase Paymentech Solutions
      ,
      FDC Compass
      ,
      TSYS Acquiring Solutions
      : 10
    • FDC Nashville Global
      : 11
    • Elavon Americas
      ,
      GPN
      ,
      OmniPay Direct
      : 12
    • RBS WorldPay Atlanta
      : 8

Mapping Information

  • REST API Fields
    :
    orderInformation.amountDetails.taxDetails[].amount
  • SCMP API Fields:
    • alternate_tax_amount
    • national_tax
    • vat_tax_amount
  • Simple Order API Fields:
    • otherTax_alternateTaxAmount
    • otherTax_nationalTaxAmount
    • otherTax_vatTaxAmount

Processor Field Names

This list identifies the processors using this field and the corresponding processor field name:
  • Chase Paymentech Solutions
    :
    Alternate Tax Amount or VAT/Tax Amount
  • Elavon Americas
    :
    National/Alternate Tax, Other Tax and VAT / Tax Amount (freight)
  • FDC Compass
    :
    Alternate Tax Amount and VAT/Tax Amount
  • FDC Nashville Global
    :
    Other Tax Amount and VAT/Tax Amount
  • GPN
    :
    National Tax, Other Tax and VAT/Tax Amount (Freight/Shipping)
  • OmniPay Direct
    :
    National Tax and VAT (Amount)
  • RBS WorldPay Atlanta
    :
    VAT Tax Amount
  • TSYS Acquiring Solutions
    :
    National Tax Amount, Alternate Tax Amount and VAT/Tax Amount

orderInformation. amountDetails.taxDetails[]. rate

The Value Added Tax (VAT) or other tax rate used to calculate the tax applied to the order.
This field is available only on the
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
FDC Nashville Global
,
GPN
,
Visa Platform Connect
,
OmniPay Direct
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
processors.
RBS WorldPay Atlanta
and
TSYS Acquiring Solutions
The valid range is between 0.01 and 99.99 percent. The rate is entered as a decimal. For example:
  • 60%:
    0.6000
  • 33.33%:
    0.3333
  • 25.5%:
    0.2550
Visa Platform Connect
The valid range is between 0.01 and 99.99 percent. The rate is entered as a percentage. For example:
  • 60%:
    60.00
  • 33.33%:
    33.33
  • 25.5%:
    25.50
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
FDC Nashville Global
,
GPN
, and
OmniPay Direct
The valid range is between 1 and 99 percent. The rate is entered as a decimal. For example:
  • 60%:
    0.60
  • 33%:
    0.33
  • 25%:
    0.25

Specifications

Chase Paymentech Solutions
,
Elavon Americas
,
GPN
,
Visa Platform Connect
,
FDC Compass
, and
OmniPay Direct
:
  • Data Type:
    String
  • Data Length:
    4
FDC Nashville Global
:
  • Data Type:
    String
  • Data Length:
    5
RBS WorldPay Atlanta
:
  • Data Type:
    Numeric
  • Data Length:
    4
TSYS Acquiring Solutions
:
  • Data Type:
    String
  • Data Length:
    6

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.taxDetails[].rate
  • SCMP API Fields:
    • other_tax#_rate
    • vat_rate
    • vat_tax_rate
  • Simple Order API Fields:
    • item_#_otherTax_#_rate
    • item_#_vatRate
    • otherTax_vatTaxRate

Processor Field Names

This list identifies the processor-specific field names for each processor supporting this field for Level II or Level III processing:
  • Chase Paymentech Solutions
    :
    VAT/Tax Rate
  • Elavon Americas
    :
    VAT / Tax Rate (Freight)
  • FDC Compass
    :
    VAT/Tax Rate
  • FDC Nashville Global
    :
    VAT/Tax Rate
  • GPN
    :
    VAT/Tax Rate (Freight/Shipping)
  • OmniPay Direct
    :
    VAT (Rate)
  • RBS WorldPay Atlanta
    :
    Tax Rate
  • TSYS Acquiring Solutions
    :
    VAT/Tax Rate
  • Visa Platform Connect
    :
    vat_tax_rate

orderInformation. amountDetails.taxDetails[]. taxID

Your tax ID number to use for the alternate tax amount.
This field is available only on the
Chase Paymentech Solutions
and
FDC Compass
processors.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.taxDetails[].taxID
  • SCMP API Field:
    alternate_tax_id
  • Simple Order API Field:
    otherTax_alternateTaxID

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:
  • Chase Paymentech Solutions
    : Alternate Tax ID
  • FDC Compass
    : Alternate Tax ID

orderInformation. amountDetails. taxDetails. type

The type of tax data that is required when using the
orderInformation.amountDetails.taxDetails.amount
request field.
Possible values:
  • alternate
    : The total amount of alternate tax for the order.
  • green
    : The green tax amount for Korean Processing.
  • local
    : The sales tax for the order.
  • national
    : The national tax for the order.
  • other
    : Other tax.
  • vat
    : The total amount of value added tax (VAT) included in the order.

Specifications

  • Data Type:
    String
  • Data Length:
    9

Mapping

  • REST Field Name:
    orderInformation.amountDetails.taxDetails.type
  • Simple Order Field Name:
    No corresponding field.

orderInformation. amountDetails.taxDetails[]. type=green

Tax amount paid to government for green initiative.

Specifications

  • Data Type:
    Integer
  • Data Length:
    12

Mapping Information

  • REST API Field and Value:
    orderInformation.amountDetails.taxDetails[].type
    =green
  • SCMP API Field:
    No corresponding field
  • Simple Order API Field:
    otherTax_greenTaxAmount

orderInformation. amountDetails.taxTypeCode

Contains the tax type code that corresponds to the entry in the
orderInformation.lineItems[].taxAmount
field.
This field is available only for
Visa Platform Connect
.
Possible values:
  • 056
    : Sales tax (U.S. Only)
  • TX~
    : All taxes (Canada Only) Note: Replace ~ with a space.

Specifications

  • Data Type:
    String
  • Data Length:
    3

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.taxTypeCode
  • SCMP API Field:
    total_tax_type_code
  • Simple Order API Field:
    invoiceHeader_totalTaxTypeCode

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:
  • Visa Platform Connect
    : totalTaxTypeCode

orderInformation. amountDetails.totalAmount

Grand total for the order.
If your request includes line items, do not include this field in your request.
This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. The amount is truncated to the correct number of decimal places.
IMPORTANT
Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.
Dynamic Currency Conversions
When this field is used in a request with Dynamic Currency Conversion, this field value must be denominated in the customer's billing currency.
Original Credit Transactions (OCT)
The amount must be less than or equal to 50,000 USD. Amount limits differ depending on limitations imposed by your acquirer in addition to local laws and regulations. For more information, contact your acquirer.
PIN Debit Transactions
If the transaction includes a cashback amount, that amount must be included in this total amount. If the transaction includes a surcharge amount, that amount must be included in this total amount.
Zero Amount Authorizations
If your processor supports zero amount authorizations, you can set this field to
0
for the authorization to verify whether the card is lost or stolen.

Specifications

  • Data Type:
    String
  • Data Length
    • Comercio Latino
      : 19
    • Other Processors: 15 (for e-check transactions), 17 (for all other transactions)

Mapping Information

  • REST API Field:
    orderInformation.amountDetails.totalAmount
  • SCMP API Fields:
    • auth_request_amount
    • bill_bill_amount
    • ecp_credit_total_amount
    • ecp_debit_total_amount
    • oct_amount
    • pin_debit_purchase_request_amount
    • tax_total_grand
  • Simple Order API Fields:
    • ccAuthReply_requestAmount
    • ccCaptureReply_amount
    • ecCreditReply_amount
    • ecDebitReply_amount
    • octReply_amount
    • pinDebitPurchaseReply_requestAmount
    • purchaseTotals_grandTotalAmount
    • taxReply_grandTotalAmount
    On
    Barclays
    and
    Comercio Latino
    , only the
    purchaseTotals_grandTotalAmount
    field is supported for authorizations.

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.
  • Barclays
    : Line Item Total
  • Chase Paymentech Solutions
    : Does not apply
  • FDC Compass
    : Does not apply
  • FDC Nashville Global
    : Does not apply
  • OmniPay Direct
    : Line Item Total
  • RBS WorldPay Atlanta
    : Amount
  • TSYS Acquiring Solutions
    : Does not apply

orderInformation. billTo. address1

First line of the billing street address as it appears in the payment card issuer records.
IMPORTANT
This field is optional if your account is configured for relaxed requirements for address data.
For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.
FDMS Nashville
When the street name is numeric, it must be sent in numeric format. For example, if the address is
One First Street
, it must be sent as
1 1st Street
.
Visa Platform Connect
When you populate billing street address 1 and billing street address 2, exceeds 40 characters,
Visa Platform Connect
truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and charge backs.
Credit card networks cannot process transactions that contain non-ASCII characters.
Visa Platform Connect
accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitation of the payment card networks prevents
Visa Platform Connect
from transmitting non-ASCII characters to the payment card networks. Therefore,
Visa Platform Connect
replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

  • Data Type:
    String
  • Data Length:
    • Chase Paymentech Solutions
      :
      20
    • Moneris
      :
      50
    • Worldpay VAP
      :
      35
    • Visa Platform Connect
      :
      40
    • All other processors:
      60

Mapping Information

  • REST API Field:
    orderInformation.billTo.address1
  • SCMP API Field:
    bill_address1
  • Simple Order API Field:
    billTo_street1

orderInformation. billTo. address2

Second line of the billing street address as it appears in the payment card issuer records.
Chase Paymentech Solutions
,
FDC Compass
, and
TSYS Acquiring Solutions
This value is used for AVS.
FDMS Nashville
The billing address 1 and billing address 2 fields together cannot exceed 20 characters.
Visa Platform Connect
When you populate billing street address 1 and billing street address 2, exceeds 40 characters,
Visa Platform Connect
truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and charge backs.
Credit card networks cannot process transactions that contain non-ASCII characters.
Visa Platform Connect
accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitation of the payment card networks prevents
Visa Platform Connect
from transmitting non-ASCII characters to the payment card networks. Therefore,
Visa Platform Connect
replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

  • Data Type:
    String
  • Data Length:
    • Chase Paymentech Solutions
      :
      20
    • Moneris
      :
      50
    • Worldpay VAP
      :
      35
    • Visa Platform Connect
      :
      40
    • All other processors:
      60

Mapping Information

  • REST API Field:
    orderInformation.billTo.address2
  • SCMP API Field:
    bill_address2
  • Simple Order API Field:
    billTo_street2

orderInformation. billTo. address3

Third line of the billing street address as it appears in the payment card issuer records.

Specifications

  • Data Type:
    String
  • Data Length:
    50

Mapping Information

  • REST API Field:
    orderInformation.billTo.address3
  • SCMP API Field:
    bill_address3
  • Simple Order API Field:
    billTo_street3

orderInformation. billTo. address4

Fourth line of the billing street address as it appears in the payment card issuer records.

Specifications

  • Data Type:
    String
  • Data Length:
    60

Mapping Information

  • REST API Field:
    orderInformation.billTo.address4
  • SCMP API Field:
    bill_address4
  • Simple Order API Field:
    billTo_street4

orderInformation. billTo.administrativeArea

State or province in the billing address.
For the US, Canada, and Mainland China, use the ISO 3166-2 format for two-character state, province, or territory codes.
For all countries, use the ISO 3166-2 format when using this field for Payer Authentication.
IMPORTANT
This field is optional if your account is configured for relaxed requirements for address data.
For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.
Visa Platform Connect
Credit card networks cannot process transactions that contain non-ASCII characters.
Visa Platform Connect
accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent
Visa Platform Connect
from transmitting non-ASCII characters to the payment card networks. Therefore,
Visa Platform Connect
replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    orderInformation.billTo.administrativeArea
  • SCMP API Field:
    bill_state
  • Simple Order API Field:
    billTo_state

orderInformation. billTo. alternateEmailAddress

Customer's alternate email address.
This field is available only for the
Visa Platform Connect
processor.

Specifications

  • Data Type:
    String
  • Data Length:
    255

Mapping Information

  • REST API Field:
    orderInformation.billTo.alternateEmailAddress
  • SCMP API Field:
    customer_alternate_email
  • Simple Order API Field:
    billTo_alternateEmailAddress

orderInformation. billTo.alternateEmailVerificationStatus

Verification results for customer's alternate email address.
If the field is not present in the authorization response, verification was not performed or data is unavailable.
This field is available only for the
Visa Platform Connect
processor.
Possible values:
  • VERIFIED:
    Customer verified.
  • UNVERIFIED:
    Customer not verified.
  • FAILED:
    Customer verification failed.

Specifications

  • Data Type:
    String
  • Data Length:
    10

Mapping Information

  • REST API Field:
    orderInformation.billTo.alternateEmailVerificationStatus
  • SCMP API Field:
    customer_other_email_result
  • Simple Order API Field:
    customer_emailResult

orderInformation. billTo. alternatePhoneNumber

Customer's alternate phone number.
This field is available only for the
Visa Platform Connect
processor.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.billTo.alternatePhoneNumber
  • SCMP API Field:
    customer_alternate_phone_number
  • Simple Order API Field:
    billTo_alternatePhoneNumber

orderInformation. billTo.alternatePhoneNumberVerificationStatus

Verification results for customer's alternate phone number.
If the field is not present in the authorization response, verification was not performed or data is unavailable.
This field is available only for the
Visa Platform Connect
processor.
Possible values:
  • VERIFIED:
    Customer verified.
  • UNVERIFIED:
    Customer not verified.
  • FAILED:
    Customer verification failed.

Specifications

  • Data Type:
    String
  • Data Length:
    10

Mapping Information

  • REST API Field:
    orderInformation.billTo.alternatePhoneNumberVerificationStatus
  • SCMP API Field:
    customer_other_phone_result
  • Simple Order API Field:
    customer_phoneResult

orderInformation. billTo.buildingNumber

Building number in the street address.
For example, for the street address Rua da Quitanda 187, set this field to the building number
187
.
This field is available only for these processors:
Cielo
,
Comercio Latino
, ,
Cybersource Latin American Processing
, and
Visa Platform Connect
.
These processors have specific requirements:
Comercio Latino
If a building number is not sent,
Comercio Latino
rejects the payment request. If the building number is not available, enter the number
0
.
Cybersource Latin American Processing
Cybersource Latin American Processing
is the name of a specific processing connection.
Cybersource Latin American Processing
does not refer to the general topic of processing in Latin America. The information in this field description, or in this section of the field description, is for the specific processing connection called
Cybersource Latin American Processing
. It is not for any other Latin American processors.

Specifications

  • Data Type:
    String
  • Data Length:
    256

Mapping Information

  • REST API Field:
    orderInformation.billTo.buildingNumber
  • SCMP API Field:
    bill_building_number
  • Simple Order API Field:
    billTo_buildingNumber

orderInformation. billTo.company.address1

First line in the street address of the company purchasing the product.
This field is available only for the
American Express Direct
processor.

Specifications

  • Data Type:
    String
  • Data Length:
    40

Mapping Information

  • REST API Field:
    orderInformation.billTo.company.address1
  • SCMP API Field:
    company_address1
  • Simple Order API Field:
    billTo_companyStreet1

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:
  • American Express Direct
    : Does not apply

orderInformation. billTo.company.address2

Additional address information for the company purchasing the product.
Example: Attention: Accounts Payable
This field is available only for the
American Express Direct
processor.

Specifications

  • Data Type:
    String
  • Data Length:
    40

Mapping Information

  • REST API Field:
    orderInformation.billTo.company.address2
  • SCMP API Field:
    company_address2
  • Simple Order API Field:
    billTo_companyStreet2

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:
  • American Express Direct
    : Does not apply

orderInformation. billTo.company.city

City in the address of the company purchasing the product.
This field is available only for the
American Express Direct
processor.

Specifications

  • Data Type:
    String
  • Data Length:
    30

Mapping Information

  • REST API Field:
    orderInformation.billTo.company.city
  • SCMP API Field:
    company_city
  • Simple Order API Field:
    billTo_companyCity

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:
  • American Express Direct
    : Does not apply

orderInformation. billTo.company.country

Two-digit ISO standard code for the country in the address of the company purchasing the product.
Use the two-character ISO country code. .
This field is available only for the
American Express Direct
processor.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    orderInformation.billTo.company.country
  • SCMP API Field:
    company_country
  • Simple Order API Field:
    billTo_companyCountry

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:
  • American Express Direct
    : Does not apply

orderInformation. billTo. company

Name of the customer's company.
Visa Platform Connect
Payment card companies cannot process transactions that contain non-ASCII characters.
Visa Platform Connect
accepts and stores ASCII characters correcty and displays them correctly in reports. However, since payment card networks cannot accept non-ASCII characters,
Visa Platform Connect
replaces non-ASCII characters with meaningless ASCII characters when tranmitting information to payment card networks.

Specifications

  • Data Type:
    String
  • Data Length:
    60

Mapping Information

  • REST API Field:
    orderInformation.billTo.company
  • SCMP API Field:
    company_city
  • Simple Order API Field:
    billTo_company

orderInformation. billTo.company.name

Name of the customer’s company.
This field is available only for these processors:
American Express Direct
,
Moneris
, and
Visa Platform Connect
.
This processor has specific requirements:
Visa Platform Connect
Credit card networks cannot process transactions that contain non-ASCII characters.
Visa Platform Connect
accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent
Visa Platform Connect
from transmitting non-ASCII characters to the payment card networks. Therefore,
Visa Platform Connect
replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

  • Data Type:
    String
  • Data Length:
    • Moneris
      :
      50
    • Visa Platform Connect
      :
      60
    • All other processors:
      40

Mapping Information

  • REST API Field:
    orderInformation.billTo.company.name
  • SCMP API Field:
    company_name
  • Simple Order API Field:
    billTo_companyName

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.
  • American Express Direct
    :
    Does not apply

orderInformation. billTo. company.phoneNumber

This field value is the business phone number.
Use digits 0 through 9 only. The first digit cannot be 0. For example, 5552223333.

Specifications

  • Data Type:
    String
  • Data Length:
    10

Mapping Information

  • REST API Field:
    orderInformation.billTo.company.phoneNumber
  • SCMP API Field:
    company_phone
  • Simple Order API Field:
    billTo_companyPhoneNumber

orderInformation. billTo.company.postalCode

Postal code in the address of the company purchasing the product.
For U.S. transactions, the postal code must consist of the 5 digit or 9 digit format:
  • 5-digit ZIP format: 12345
  • 9-digit ZIP+ format: 12345-6789
For Canadian transactions, the postal code must use the 6-digit postal code format:
  • 6-digit format: A1B 2C3
This field is available only for the
American Express Direct
processor.

Specifications

  • Data Type:
    String
  • Data Length:
    10

Mapping Information

  • REST API Field:
    orderInformation.billTo.company.postalCode
  • SCMP API Field:
    company_zip
  • Simple Order API Field:
    billTo_companyPostalCode

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:
  • American Express Direct
    : Does not apply

orderInformation. billTo.company.state

State or province in the address of the company purchasing the product.
For US and Canadian transactions, use the standard two-digit state/province codes.
This field is available only for the
American Express Direct
processor.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    orderInformation.billTo.company.state
  • SCMP API Field:
    company_state
  • Simple Order API Field:
    billTo_companyState

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:
  • American Express Direct
    : Does not apply

orderInformation. billTo.country

Country in the billing address.
Use the two-character ISO country code. .
IMPORTANT
This field is optional if your account is configured for relaxed requirements for address data.
For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.
Tax Calculation Service
  • U.S and Canadian Tax
    : Required
  • International Tax and Value-Added Tax (VAT)
    : Required
Visa Platform Connect
Credit card networks cannot process transactions that contain non-ASCII characters.
Visa Platform Connect
accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent
Visa Platform Connect
from transmitting non-ASCII characters to the payment card networks. Therefore,
Visa Platform Connect
replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    orderInformation.billTo.country
  • SCMP API Field:
    bill_country
  • Simple Order API Field:
    billTo_country

orderInformation. billTo. county

The county of the customer.

Specifications

  • Data Type:
    String
  • Data Length:
    50

Mapping

  • REST Field Name:
    orderInformation.billTo.county
  • Simple Order Field Name:
    billTo_county

orderInformation. billTo.district

Customer’s neighborhood, community, or region (a barrio in Brazil) within the city or municipality.
Comercio Latino
If the district information is not available, specify the text string
district
.

Specifications

  • Data Type:
    String
  • Data Length:
    50

Mapping Information

  • REST API Field:
    orderInformation.billTo.district
  • SCMP API Field:
    bill_district
  • Simple Order API Field:
    billTo_district

orderInformation. billTo.email

Customer's email address, including full domain name.
Format: name@host.domain
IMPORTANT
This field is optional if your account is configured for relaxed requirements for address data.
For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.
Visa Platform Connect
Credit card networks cannot process transactions that contain non-ASCII characters.
Visa Platform Connect
accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent
Visa Platform Connect
from transmitting non-ASCII characters to the payment card networks. Therefore,
Visa Platform Connect
replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

  • Data Type:
    String
  • Data Length:
    255

Mapping Information

  • REST API Field:
    orderInformation.billTo.email
  • SCMP API Field:
    customer_email
  • Simple Order API Field:
    billTo_email

orderInformation. billTo.firstName

Customer name.
Value should match value on card.
IMPORTANT
This field is optional if your account is configured for relaxed requirements for address data.
For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.
Cybersource Latin American Processing
For an authorization request,
Cybersource Latin American Processing
concatenates
orderInformation.billTo.firstName
and
orderInformation.billTo.lastName
. If the concatenated value exceeds 30 characters,
Cybersource Latin American Processing
declines the authorization request.
Cybersource Latin American Processing
is the name of a specific processing connection.
Cybersource Latin American Processing
does not refer to the general topic of processing in Latin America. The information in this field description, or in this section of the field description, is for the specific processing connection called
Cybersource Latin American Processing
. It is not for any other Latin American processors.
Visa Platform Connect
Credit card networks cannot process transactions that contain non-ASCII characters.
Visa Platform Connect
accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent
Visa Platform Connect
from transmitting non-ASCII characters to the payment card networks. Therefore,
Visa Platform Connect
replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

  • Data Type:
    String
  • Data Length:
    60
  • Data Length:
    • Cybersource Latin American Processing
      :
      See field description.
    • Worldpay VAP
      :
      25
    • All other processors:
      60

Mapping Information

  • REST API Field:
    orderInformation.billTo.firstName
  • SCMP API Field:
    customer_firstname
  • Simple Order API Field:
    billTo_firstName

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.
  • American Express Direct
    :
    Does not apply

orderInformation. billTo.lastName

Last name of the person requesting the product.
This person may or may not be the cardholder.
IMPORTANT
This field is optional if your account is configured for relaxed requirements for address data.
For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.
American Express Direct
Combined, this field and should not exceed 40 characters.
Cybersource Latin American Processing
For an authorization request,
Cybersource Latin American Processing
concatenates
orderInformation.billTo.firstName
and
customer_lastname
orderInformation.billTo.lastName
. If the concatenated value exceeds 30 characters,
Cybersource Latin American Processing
declines the authorization request.
Cybersource Latin American Processing
is the name of a specific processing connection.
Cybersource Latin American Processing
does not refer to the general topic of processing in Latin America. The information in this field description, or in this section of the field description, is for the specific processing connection called
Cybersource Latin American Processing
. It is not for any other Latin American processors.

Specifications

  • Data Type:
    String
  • Data Length:
    60
  • Data Length:
    • Cybersource Latin American Processing
      :
      See field description.
    • Worldpay VAP
      :
      25
    • All other processors:
      60

Mapping Information

  • REST API Field:
    orderInformation.billTo.lastName
  • SCMP API Field:
    customer_lastname
  • Simple Order API Field:
    billTo_lastName

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.
  • American Express Direct
    :
    Does not apply

orderInformation. billTo.locality

City in the billing address.
IMPORTANT
This field is optional if your account is configured for relaxed requirements for address data.
For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.
Visa Platform Connect
Credit card networks cannot process transactions that contain non-ASCII characters.
Visa Platform Connect
accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent
Visa Platform Connect
from transmitting non-ASCII characters to the payment card networks. Therefore,
Visa Platform Connect
replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

  • Data Type:
    String
  • Data Length:
    50

Mapping Information

  • REST API Field:
    orderInformation.billTo.locality
  • SCMP API Field:
    bill_city
  • Simple Order API Field:
    billTo_city

orderInformation.billTo. middleName

The customer's middle name.

Specifications

  • Data Type:
    String
  • Data Length:
    40

Mapping Information

  • REST API Field:
    orderInformation.billTo.middleName
  • SCMP API Field:
    customer_middlename
  • Simple Order API Field:
    billTo_middleName

orderInformation.billTo. namePrefix

Name prefix.
For example, Dr.

Specifications

  • Data Type:
    String
  • Data Length:
    4

Mapping Information

  • REST API Field:
    orderInformation.billTo.namePrefix
  • SCMP API Field:
    customer_prefix
  • Simple Order API Field:
    billTo_prefix

orderInformation.billTo. nameSuffix

Name suffix.
For example, Jr.

Specifications

  • Data Type:
    String
  • Data Length:
    4

Mapping Information

  • REST API Field:
    orderInformation.billTo.nameSuffix
  • SCMP API Field:
    customer_suffix
  • Simple Order API Field:
    billTo_suffix

orderInformation. billTo.phoneNumber

Customer's phone number.
Include the country code when the order is from outside the US.
Visa Platform Connect
Credit card networks cannot process transactions that contain non-ASCII characters.
Visa Platform Connect
accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent
Visa Platform Connect
from transmitting non-ASCII characters to the payment card networks. Therefore,
Visa Platform Connect
replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.
For installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP07 TCR4
  • Position: 40-50
  • Field: Buyer Phone Number
The TC 33 capture file contains information about the payments and credits that a merchant submits to
Cybersource
. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

  • Data Type:
    String
  • Data Length:
    • Visa Platform Connect
      :
      11 (Installment Payments with Mastercard in Brazil), 15 (All other payment types)
    • All other processors:
      15

Mapping Information

  • REST API Field:
    orderInformation.billTo.phoneNumber
  • SCMP API Field:
    customer_phone
  • Simple Order API Field:
    billTo_phoneNumber

orderInformation. billTo.postalCode

Postal code in the billing address.
The postal code must consist of five to nine digits.
When the billing country is the US, the nine-digit postal code must follow this format: [5 digits][dash][4 digits].
Example
: 12345-6789
When the billing country is Canada, the six-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric]
Example
: A1B 2C3
IMPORTANT
This field is optional if your account is configured for relaxed requirements for address data.
For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.
American Express Direct
Before the postal code is sent to the processor, all non-alphanumeric characters are removed, and if the remaining value is longer than nine characters, the value is truncated starting from the right side.
Visa Platform Connect
Credit card networks cannot process transactions that contain non-ASCII characters.
Visa Platform Connect
accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent
Visa Platform Connect
from transmitting non-ASCII characters to the payment card networks. Therefore,
Visa Platform Connect
replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

  • Data Type:
    String
  • Data Length:
    10
  • Data Length:
    • Comercio Latino
      : 9
    • Visa Platform Connect
      : 9
    • All other processors: 10

Mapping Information

  • REST API Field:
    orderInformation.billTo.postalCode
  • SCMP API Field:
    bill_zip
  • Simple Order API Field:
    billTo_postalCode

orderInformation. billTo. title

The title of the customer.

Specifications

  • Data Type:
    String
  • Data Length:
    30

Mapping

  • REST Field Name:
    orderInformation.billTo.title
  • Simple Order Field Name:
    billTo_title

orderInformation. exemptAmount

Total amount of exempt amounts.
This value is the sum of the values for all the
orderInformation.lineItems[].exemptAmount
fields.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.exemptAmount
  • SCMP API Field:
    tax_total_exempt_amount
  • Simple Order API Field:
    taxReply_totalExemptAmount

orderInformation. invoiceDetails.commodityCode

International description code of the overall order's goods or services.
Contact your acquirer or processor for a list of codes.
This field is available only for the
American Express Direct
,
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
FDC Nashville Global
,
FDMS South
,
GPN
,
Visa Platform Connect
,
OmniPay Direct
,
TSYS Acquiring Solutions
, and
Worldpay VAP
processors.
Elavon Americas
Used to categorize purchases for VAT reporting.
FDMS South
This field might be required for Level III processing depending on your merchant category code. Check with your processor for more information.

Specifications

  • Data Type:
    String
  • Data Length:
    4

Mapping Information

  • REST API Field:
    orderInformation.invoiceDetails.commodityCode
  • SCMP API Field:
    summary_commodity_code
  • Simple Order API Field:
    invoiceHeader_summaryCommodityCode

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:
  • Elavon Americas
    : Purchase Identifier
  • FDMS South
    : Does not apply
  • GPN
    : Summary Commodity Code and Commodity Code
  • OmniPay Direct
    : Summary Commodity Code
  • RBS WorldPay Atlanta
    : Commodity Code
  • TSYS Acquiring Solutions
    : Does not apply
  • Visa Platform Connect
    : summaryCommodityCode

orderInformation. invoiceDetails.costCenter

Cost center for the goods being sold.
This field is available only on the
Barclays
processor.

Specifications

  • Data Type:
    String
  • Data Length:
    25

Mapping Information

  • REST API Field:
    orderInformation.invoiceDetails.costCenter
  • SCMP API Field:
    cost_center
  • Simple Order API Field:
    invoiceHeader_costCenter

orderInformation. invoiceDetails.invoiceDate

Date of the tax calculation in Pacific Time.
If you do not include this field in the request, the tax calculation date is set to the current date.
  • You can provide a date in the past when 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 when you are calculating the tax for a future date, such as an upcoming tax holiday.
IMPORTANT
Adjust this value when you are in a different time zone and want the tax calculated with the rates that apply on a specific date.
Barclays
Format: yyyyMMddHHmmss
Other processors
Format: yyyyMMdd

Specifications

  • Data Type:
    String
  • Data Type:
    String
  • Data Length
    • Barclays
      : 14
    • Other processors: 8

Mapping Information

  • REST API Field:
    orderInformation.invoiceDetails.invoiceDate
  • SCMP API Field:
    invoice_date
  • Simple Order API Field:
    invoiceHeader_invoiceDate

orderInformation. invoiceDetails. merchandiseCode

Identifier for the merchandise.
This field is available only on the
American Express Direct
,
JCN Gateway
, and
Visa Platform Connect
processors.
American Express Direct
The value is
1000
: gift card.
JCN Gateway
This value must be right justified. In Japan, this value is called a goods code.
Visa Platform Connect
This value must be right justified. In Japan, this value is called a goods code.

Specifications

  • Data Type:
    Integer
  • Data Length:
    7

Mapping Information

  • REST API Field:
    orderInformation.invoiceDetails.merchandiseCode
  • SCMP API Field:
    merchandise_code
  • Simple Order API Field:
    merchandiseCode

orderInformation. invoiceDetails. purchaseContactName

The name of the individual or the company contacted for company authorized purchases.
This field is available only on the
Visa Platform Connect
processor.

Specifications

  • Data Type:
    String
  • Data Length:
    36

Mapping Information

  • REST API Field:
    orderInformation.invoiceDetails.purchaseContactName
  • SCMP API Field:
    authorized_contact_name
  • Simple Order API Field:
    invoiceHeader_authorizedContactName

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:
  • Visa Platform Connect
    : authorizedContactName

orderInformation. invoiceDetails.purchaseOrderDate

Date the order was processed.
This field is available only on the
Barclays
,
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
FDC Nashville Global
,
GPN
,
OmniPay Direct
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
,
Visa Platform Connect
, and
Worldpay VAP
processors.
Barclays
Format: yyyyMMdd
Worldpay VAP
Format: yyyy-MM-DD
Other processors
Format: YYMMDD

Specifications

  • Data Type:
    String
  • Data Length
    • Barclays
      : 8
    • Worldpay VAP
      : 10
    • Other processors: 6

Mapping Information

  • REST API Field:
    orderInformation.invoiceDetails.purchaseOrderDate
  • SCMP API Field:
    purchaser_order_date
  • Simple Order API Field:
    invoiceHeader_purchaserOrderDate

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:
  • Elavon Americas
    : Order Date
  • GPN
    : Order Date
  • OmniPay Direct
    : Order Date
  • RBS WorldPay Atlanta
    : Order Date
  • TSYS Acquiring Solutions
    : Order Date
  • Visa Platform Connect
    : purchaserOrderDate
  • Worldpay VAP
    : orderDate

orderInformation. invoiceDetails.purchaseOrderNumber

Value used by your customer to identify the order.
This value is typically a purchase order number.
Cybersource
recommends that you do not populate the field with all zeros or nines.
This field is available only on the
Barclays
,
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
FDC Nashville Global
,
GPN
,
OmniPay Direct
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
,
Visa Platform Connect
, and
Worldpay VAP
processors.
FDC Nashville Global
Only alphanumeric characters are accepted on
FDC Nashville Global
. Do not include hyphens or other non-alphanumeric characters. You must provide a value in this field or in the
clientReferenceInformation.code
field.

Specifications

  • Data Type:
    String
  • Data Length
    • American Express Direct
      : 17
    • Barclays
      : 25
    • Chase Paymentech Solutions
      : 25
    • Elavon Americas
      : 17
    • FDC Compass
      : 25
    • FDC Nashville Global
      : 25
    • GPN
      : 17 for Mastercard, 25 for Visa
    • OmniPay Direct
      : 17 for Mastercard, 25 for Visa
    • FDMS Nashville
      : 25
    • FDMS South
      : 25
    • RBS WorldPay Atlanta
      : 25
    • Visa Platform Connect
      : 17
    • TSYS Acquiring Solutions
      : 25
    • Worldpay VAP
      : 17

Mapping Information

  • REST API Field:
    orderInformation.invoiceDetails.purchaseOrderNumber
  • SCMP API Field:
    user_po
  • Simple Order API Field:
    invoiceHeader_userPO

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:
  • American Express Direct
    : does not apply
  • Chase Paymentech Solutions
    : Customer Reference Number
  • Elavon Americas
    : Purchase Identifier
  • FDC Compass
    : Customer Reference Number
  • FDC Nashville Global
    : Customer Code
  • FDMS Nashville
    : does not apply
  • FDMS South
    : does not apply
  • GPN
    : Market Data - Customer Code and Reference Number
  • OmniPay Direct
    : Customer Code / Customer Reference ID
  • RBS WorldPay Atlanta
    : PC2 Customer ID
  • TSYS Acquiring Solutions
    : does not apply
  • Visa Platform Connect
    : customerCode
  • Worldpay VAP
    : customerReference

orderInformation. invoiceDetails. referenceDataCode

Code that identifies the value of the
orderInformation.invoiceDetails.referenceDataNumber
field.
This field is available only for the
American Express Direct
processor.
This field is a pass-through, which means that this value is not verified or modified in any way before it is sent to the processor.

Specifications

  • Data Type:
    String
  • Data Length:
    3

Mapping Information

  • REST API Field:
    orderInformation.invoiceDetails.referenceDataCode
  • SCMP API Field:
    reference_data_code
  • Simple Order API Field:
    invoiceHeader_referenceDataCode

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:
  • American Express Direct
    : Does not apply

orderInformation. invoiceDetails.referenceDataNumber

Reference number associated with the
orderInformation. invoiceDetails.referenceDataCode
field.
This field is available only on the
American Express Direct
and
Barclays
processors.
The meaning of this reference number is defined by the
orderInformation.invoiceDetails.referenceDataCode
field.
IMPORTANT
This field is a pass-through. The value in this field is not verified or modified in any way before it is sent to the processor.

Specifications

  • Data Type:
    String
  • Data Length:
    30

Mapping Information

  • REST API Field:
    orderInformation.invoiceDetails.referenceDataNumber
  • SCMP API Field:
    reference_data_number
  • Simple Order API Field:
    invoiceHeader_referenceDataNumber

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:
  • American Express Direct
    : Does not apply

orderInformation. invoiceDetails.supplierOrderReference

Text description of the item.
This field is available on the
Barclays
,
FDC Nashville Global
, and
OmniPay Direct
processors.
FDC Nashville Global
Due to the limited functionality of this field, you should use the
orderInformation.lineItems[].productName
field instead.
IMPORTANT
Include only one of these fields in a request. Including both fields may result in an error.

Specifications

  • Data Type:
    String
  • Data Length
    • Barclays
      : 25
    • FDC Nashville Global
      : 25
    • OmniPay Direct
      : 17 for Mastercard payment cards, 25 for Visa payment cards

Mapping Information

  • REST API Field:
    orderInformation.invoiceDetails.supplierOrderReference
  • SCMP API Field:
    supplier_order_reference
  • Simple Order API Field:
    invoiceHeader_supplierOrderReference

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:
  • FDC Nashville Global
    : Item Description Part A
  • OmniPay Direct
    : Purchase Identifier / Merchant-Related Data / Merchant Reference Number

orderInformation. invoiceDetails. taxable

Flag that indicates whether an order is taxable.
This field is available 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
    : Does not apply
  • FDMS South
    : Does not apply
  • OmniPay Direct
    : Detail Tax Amount Indicator
  • RBS WorldPay Atlanta
    : Tax Exempt
  • Visa Platform Connect
    : localTaxIncluded
  • Worldpay VAP
    : taxExempt

orderInformation. invoiceDetails. transactionAdviceAddendum[].data

Transaction Advice Addendum (TAA).
This field provides a description to display on the customer’s American Express card statement. It is frequently used for Level II transactions. Before using this field, contact customer support to have your account enabled for this feature.
This field is available only for the
American Express Direct
,
Chase Paymentech Solutions
,
FDC Compass
,
Visa Platform Connect
, and
Worldpay VAP
processors.

Specifications

  • Data Type:
    String
  • Data Length:
    • Worldpay VAP
      :
      26
    • All other processors:
      40

Mapping Information

  • REST API Field:
    orderInformation.invoiceDetails.transactionAdviceAddendum[].data
  • SCMP API Fields:
    • amexdata_taa1
    • amexdata_taa2
    • amexdata_taa3
    • amexdata_taa4
  • Simple Order API Fields:
    • invoiceHeader_amexDataTAA1
    • invoiceHeader_amexDataTAA2
    • invoiceHeader_amexDataTAA3
    • invoiceHeader_amexDataTAA4

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:
  • American Express Direct
    :
    Does not apply
  • Chase Paymentech Solutions
    :
    • TAA1
    • TAA2
    • TAA3
    • TAA4
  • FDC Compass
    :
    • TAA1
    • TAA2
    • TAA3
    • TAA4
  • Visa Platform Connect
    :
    • amexDataTAA1
    • amexDataTAA2
    • amexDataTAA3
    • amexDataTAA4
  • Worldpay VAP
    :
    itemDescription

orderInformation. invoiceDetails. vatInvoiceReferenceNumber

VAT invoice number associated with the transaction.
This field is available only on the
Elavon Americas
,
FDC Nashville Global
,
Visa Platform Connect
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
, and
Worldpay VAP
processors.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.invoiceDetails.vatInvoiceReferenceNumber
  • SCMP API Field:
    vat_invoice_ref_number
  • Simple Order API Field:
    invoiceHeader_vatInvoiceReferenceNumber

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:
  • Elavon Americas
    : VAT Invoice Reference Number (Unique)
  • FDC Nashville Global
    : VAT Invoice Reference Number
  • RBS WorldPay Atlanta
    : VAT Invoice Number
  • TSYS Acquiring Solutions
    : Unique VAT Invoice Reference Number
  • Visa Platform Connect
    : vatInvoiceReferenceNumber
  • Worldpay VAP
    : Invoice Reference Number

orderInformation. isCryptocurrencyPurchase

Flag that specifies whether the payment is for the purchase of cryptocurrency.
This field is available only for merchants who support quasi-cash.
This field is available only for Visa transactions on the
Visa Platform Connect
processor.
Possible values:
  • true
    : Payment is for the purchase of cryptocurrency.
  • false
    (default): Payment is not for the purchase of cryptocurrency.
The value for this field does not map to the TC 33 capture file.

Specifications

  • Data Type:
    String
  • Data Length:
    6

Mapping Information

  • REST API Field:
    orderInformation.isCryptocurrencyPurchase
  • SCMP API Field:
    cryptocurrency_purchase
  • Simple Order API Fields:
    • ccAuthService_cryptocurrencyPurchase
    • ccSaleService_cryptocurrencyPurchase

orderInformation. lineItems[].allowedExportCountries[]

List of countries where the product can be exported.
Use the two-character ISO country code. .
This field is used only when the
processingInformation.actionList
field contains the value
WATCHLIST_SCREENING
.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].allowedExportCountries[]
  • SCMP API Field:
    export
  • Simple Order API Field:
    item_#_export

orderInformation. lineItems[]. amountIncludesTax

This field contains a flag that indicates whether the tax amount is included in the line item total.
Possible values:
  • Y
    : Tax included in item amount.
  • N
    : Tax not included in item amount.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].amountIncludesTax
  • SCMP API Field:
    gross_net_indicator
  • Simple Order API Field:
    item_#_grossNetIndicator

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:
  • Chase Paymentech Solutions
    : Gross/Net Indicator
  • Elavon Americas
    (Mastercard): Net/Gross Indicator
  • FDC Compass
    : Gross Net Indicator
  • RBS WorldPay Atlanta
    : Gross Net Indicator
  • TSYS Acquiring Solutions
    : Net/Gross Indicator

orderInformation. lineItems[].commodityCode

Commodity code used to classify an item.
Only alphanumeric characters are accepted. Do not include hyphens or other non-alphanumeric characters.
This field is available on the
Barclays
,
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
FDC Nashville Global
,
GPN
,
OmniPay Direct
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
,
Visa Platform Connect
, and
Worldpay VAP
processors.

Specifications

  • Data Type:
    String
  • Data Length
    • Barclays
      : 35
    • Chase Paymentech Solutions
      : 12
    • Elavon Americas
      : 12
    • FDC Compass
      : 12
    • FDC Nashville Global
      : 12
    • GPN
      : 15 for Mastercard payment cards, 12 for Visa payment cards
    • OmniPay Direct
      : 4 for Mastercard payment cards, 12 for Visa payment cards
    • RBS WorldPay Atlanta
      : 12
    • TSYS Acquiring Solutions
      : 12
    • Visa Platform Connect
      : 12

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].commodityCode
  • SCMP API Field:
    commodity_code
  • Simple Order API Field:
    item_#_commodityCode

Processor Field Names

This list provides the processor-specific field names for each processor supporting this field for Level II or Level III processing:
  • Barclays
    : Commodity Code
  • Chase Paymentech Solutions
    : Item Commodity Code
  • Elavon Americas
    : Item Commodity Code
  • FDC Compass
    : Item Commodity Code
  • FDC Nashville Global
    : Item Commodity Code
  • GPN
    : Item Commodity Code
  • OmniPay Direct
    : Item Commodity Code
  • RBS WorldPay Atlanta
    : Commodity Code
  • TSYS Acquiring Solutions
    : Item Commodity Code
  • Visa Platform Connect
    : commodityCode
  • Worldpay VAP
    : commodityCode

orderInformation. lineItems[].discountAmount

Discount applied to the item.
This field may be required for all Level III processing, depending on your merchant category code. Check with your processor.
FDC Nashville Global
Do not set this field to 0 (zero) for Mastercard transactions.
GPN
The maximum value of this field is
99,999.99

Specifications

  • Data Type:
    String
  • Data Length:
    • RBS WorldPay Atlanta
      :
      8
    • Worldpay VAP
      :
      8
    • FDC Nashville Global
      :
      13
    • TSYS Acquiring Solutions
      :
      13
    • Elavon Americas
      :
      9 (Mastercard), 12 (Visa)
    • FDC Compass
      :
      10 (Mastercard), 13 (Visa)
    • Chase Paymentech Solutions
      :
      10 (Mastercard), 13 (Visa)
    • All other processors:
      12

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].discountAmount
  • SCMP API Field:
    discount_amount
  • Simple Order API Field:
    item_#_discountAmount

Processor Field Names

This list provides the processor-specific field names for each processor supporting this field for Level II or Level III processing:
  • Chase Paymentech Solutions
    :
    • Mastercard:
      Discount Amount
    • Visa:
      Discount Amount for Line Item
  • Elavon Americas
    :
    • Mastercard:
      Discount Amount
    • Visa:
      Discount Amount Per Line Item
  • FDC Compass
    :
    • Mastercard:
      Discount Amount
    • Visa:
      Discount Amount for Line Item
  • FDC Nashville Global
    :
    Item Discount Amount
  • GPN
    :
    Item Discount
  • OmniPay Direct
    :
    • Mastercard:
      Discount Amount
    • Visa:
      Discount Amount for Line Item
  • RBS WorldPay Atlanta
    :
    Discount Amount
  • TSYS Acquiring Solutions
    :
    • Mastercard:
      Discount Amount
    • Visa:
      Discount Amount Per Line Item
  • Visa Platform Connect
    :
    discountAmount
  • Worldpay VAP
    :
    Item Discount Amount

orderInformation. lineItems[].discountApplied

Flag indicating a discount was applied to the item.
Possible values:
  • Y
    : Discount applied
  • N
    : No Discount applied
This field is automatically set to
true
if the
orderInformation.lineItems[].discountApplied
field is greater than 0.

Specifications

  • Data Type:
    Boolean
  • Length:
    1

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].discountApplied
  • SCMP API Field:
    discount_indicator
  • Simple Order API Field:
    item_#_discountIndicator

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:
  • Chase Paymentech Solutions
    : Discount Indicator
  • Elavon Americas
    : Discount Indicator
  • FDC Compass
    : Discount Indicator
  • TSYS Acquiring Solutions
    : Discount Indicator

orderInformation. lineItems[].discountRate

Rate at which the item is discounted.
Additional details for all processors and all txns (Level II/III and non-Level II/III):
GPN
,
TSYS Acquiring Solutions
, and
Visa Platform Connect
A maximum of 2 decimal places is allowed. Example 5.25 (=5.25%)
OmniPay Direct
Valid range: 0.010 to 0.999 (1% to 99.9%). Example 0.050 (=5%)
RBS WorldPay Atlanta
Maximum amount is 99.99. Example 5.25 (=5.25%)

Specifications

  • Data Type:
    String
  • Data Length:
    6

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].discountRate
  • SCMP API Field:
    discount_rate
  • Simple Order API Field:
    item_#_discountRate

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:
  • GPN
    : Item Discount Rate
  • OmniPay Direct
    : Item Discount Rate
  • RBS WorldPay Atlanta
    : Discount Rate
  • TSYS Acquiring Solutions
    : Item Discount Rate
  • Visa Platform Connect
    : discountRate

orderInformation. lineItems[].distributorProductSku

Product's identifier code.
This field is inserted into the outgoing message without being parsed or formatted. This field is included as
Distributor product SKU (Offer)
in the list of API fields with which you can create custom rules.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].distributorProductSku
  • SCMP API Field:
    distributor_product_sku
  • Simple Order API Field:
    No corresponding field.

orderInformation. lineItems[].exemptAmount

Exempt amount for the item.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].exemptAmount
  • SCMP API Fields:
    • other_tax#_status_indicator
    • tax_exempt_amount0…N
  • Simple Order API Fields:
    • item_#_otherTax_#_statusIndicator
    • taxReply_item_#_exemptAmount

orderInformation. lineItems[].invoiceNumber

Field to support an invoice number for a transaction.
You must specify the number of offer lines that will include an invoice number. By default, the first offer line includes an invoice number field. By default, the first offer line includes an invoice number field. The invoice number field can be included for up to 10 offer lines.

Specifications

  • Data Type:
    String
  • Data Length:
    23
  • Data Length:
    • Visa Platform Connect
      :
      15
    • All other processors:
      23

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].invoiceNumber
  • SCMP API Field:
    invoice_number
  • Simple Order API Field:
    item_#_invoiceNumber

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.
  • American Express Direct
    :
    Does not apply
  • Chase Paymentech Solutions
    :
    Does not apply
  • FDC Compass
    :
    Does not apply
  • FDC Nashville Global
    :
    Does not apply
  • FDMS Nashville
    :
    Amount
  • FDMS South
    :
    Amount
  • GPN
    :
    Amount
  • RBS WorldPay Atlanta
    :
    Amount
  • TSYS Acquiring Solutions
    :
    Amount
  • Visa Platform Connect
    :
    invoiceNumber
  • Worldpay VAP
    :
    invoiceNumber

orderInformation. lineItems[].jurisdiction[]. code

Jurisdiction code assigned by the tax provider.
Returned only when the
taxInformation.showTaxPerLineItem
field is set to
yes
.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].jurisdiction[].code
  • SCMP API Field:
    tax_offer#_jurisdiction#_code
  • Simple Order API Field:
    taxReply_item_#_jurisdiction_#_code

orderInformation. lineItems[].jurisdiction[]. country

Jurisdiction country for the item.
Returned only when the
taxInformation.showTaxPerLineItem
field is set to
yes
.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].jurisdiction[].country
  • SCMP API Field:
    tax_offer#_jurisdiction#_country
  • Simple Order API Field:
    taxReply_item_#_jurisdiction_#_country

orderInformation. lineItems[].jurisdiction[]. name

Free-text description of the jurisdiction for the item. For example, San Mateo County
Returned only when the
taxInformation.showTaxPerLineItem
field is set to
yes
.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].jurisdiction[].name
  • SCMP API Field:
    tax_offer#_jurisdiction#_name
  • Simple Order API Field:
    taxReply_item_#_jurisdiction_#_name

orderInformation. lineItems[].jurisdiction[]. rate

Jurisdiction tax rate for the item.
Returned only when the
taxInformation.showTaxPerLineItem
field is set to
yes
.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].jurisdiction[].rate
  • SCMP API Field:
    tax_offer#_jurisdiction#_rate
  • Simple Order API Field:
    taxReply_item_#_jurisdiction_#_rate

orderInformation. lineItems[].jurisdiction[]. region

Free-text description of the jurisdiction region for the item.
For example, CA (California State) or GB (Great Britain).
Returned only when the
taxInformation.showTaxPerLineItem
field is set to
yes
.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].jurisdiction[].region
  • SCMP API Field:
    tax_offer#_jurisdiction#_region
  • Simple Order API Field:
    taxReply_item_#_jurisdiction_#_region

orderInformation. lineItems[].jurisdiction[]. taxable

Jurisdiction taxable amount for the item, not including product level exemptions.
Returned only when the
taxInformation.showTaxPerLineItem
field is set to
yes
.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].jurisdiction[].taxable
  • SCMP API Field:
    tax_offer#_jurisdiction#_taxable
  • Simple Order API Field:
    taxReply_item_#_jurisdiction_#_taxable

orderInformation. lineItems[].jurisdiction[]. taxAmount

Jurisdiction taxable amount for the item.
Returned only when the
taxInformation.showTaxPerLineItem
field is set to
yes
.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].jurisdiction[].taxAmount
  • SCMP API Field:
    tax_offer#_jurisdiction#_tax_amount
  • Simple Order API Field:
    taxReply_item_#_jurisdiction_#_taxAmount

orderInformation. lineItems[].jurisdiction[]. taxName

Name of the jurisdiction tax for the item.
For example, CA State Tax.
Returned only when the
taxInformation.showTaxPerLineItem
field is set to
yes
.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].jurisdiction[].taxName
  • SCMP API Field:
    tax_offer#_jurisdiction#_tax_name
  • Simple Order API Field:
    taxReply_item_#_jurisdiction_#_taxName

orderInformation. lineItems[].jurisdiction[]. type

Type of jurisdiction for the item.
For example, city, county, state, country, or special.
Returned only when the
taxInformation.showTaxPerLineItem
field is set to
yes
.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].jurisdiction[].type
  • SCMP API Field:
    tax_offer#_jurisdiction#_type
  • Simple Order API Field:
    taxReply_item_#_jurisdiction_#_type

orderInformation. lineItems[]. orderAcceptance. administrativeArea

State where you accept the customer’s order.
Use the state, province and territory codes for the US and Canada.
This
line item
field overrides the corresponding request-level field.
This field is not used for Tax Calculation unless the
orderInformation.lineItems[].orderOrigin.locality
and
orderInformation.lineItems[].orderAcceptance.country
fields are present.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].orderAcceptance.administrativeArea
  • SCMP API Field:
    order_acceptance_state
  • Simple Order API Fields:
    • item_#_orderAcceptanceState
    • taxService_orderAcceptanceState

orderInformation. lineItems[].orderAcceptance. country

Country where you accept the customer’s order.
Use the two-character ISO standard country code.
This
line item
field overrides the corresponding request-level field.
This field is not used for tax calculation unless the
and
orderInformation.lineItems[].orderOrigin.locality
fields are present.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].orderAcceptance.country
  • SCMP API Field:
    order_acceptance_country
  • Simple Order API Fields:
    • item_#_orderAcceptanceCountry
    • taxService_orderAcceptanceCountry

orderInformation. lineItems[].orderAcceptance. locality

City where you accept the customer’s order.
This
line item
field overrides the corresponding request-level field.
This field is not used for tax calculation unless the
orderInformation.lineItems[].orderAcceptance.administrativeArea
and
orderInformation.lineItems[].orderAcceptance.country
fields are present.

Specifications

  • Data Type:
    String
  • Data Length:
    50

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].orderAcceptance.locality
  • SCMP API Field:
    order_acceptance_city
  • Simple Order API Fields:
    • item_#_orderAcceptanceCity
    • taxService_orderAcceptanceCity

orderInformation. lineItems[].orderAcceptance. postalCode

Postal code where you accept the customer’s order.
This
line item
field overrides the corresponding request-level field.
This field is not used for Tax Calculation unless the
orderInformation.lineItems[].orderAcceptance.locality
,
orderInformation.lineItems[].orderAcceptance.administrativeArea
, and
orderInformation.lineItems[].orderAcceptance.country
fields are present.
Must be sent at the line or offer level to be surfaced in the Tax Detail Report.

Specifications

  • Data Type:
    String
  • Data Length:
    10

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].orderAcceptance.postalCode
  • SCMP API Field:
    order_acceptance_zip
  • Simple Order API Fields:
    • item_#_orderAcceptancePostalCode
    • taxService_orderAcceptancePostalCode

orderInformation. lineItems[].orderOrigin. administrativeArea

State where you receive the customer’s order.
Use the state, province and territory codes for the US and Canada.
This
line item
field overrides the corresponding request-level field.
This field is not used for tax calculation unless the
orderInformation.lineItems[].orderOrigin.locality
and
orderInformation.lineItems[].orderOrigin.country
fields are present

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].orderOrigin.administrativeArea
  • SCMP API Field:
    order_origin_state
  • Simple Order API Fields:
    • item_#_orderOriginState
    • taxService_orderOriginState

orderInformation. lineItems[].orderOrigin.country

Country where you receive the customer’s order.
Use the two-character ISO standard country code.
This
line item
field overrides the corresponding request-level field.
This field is not used for tax calculation unless the
orderInformation.lineItems[].orderOrigin.administrativeArea
and
orderInformation.lineItems[].orderOrigin.locality>
fields are present.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].orderOrigin.country
  • SCMP API Field:
    order_origin_country
  • Simple Order API Fields:
    • item_#_orderOriginCountry
    • taxService_orderOriginCountry

orderInformation. lineItems[].orderOrigin.locality

City where you receive the customer’s order.
This
line item
field overrides the corresponding request-level field.
This field is not used for tax calculation unless the
orderInformation.lineItems[].orderOrigin.administrativeArea
and
orderInformation.lineItems[].orderOrigin.country
fields are present

Specifications

  • Data Type:
    String
  • Data Length:
    50

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].orderOrigin.locality
  • SCMP API Field:
    order_origin_city
  • Simple Order API Fields:
    • item_#_orderOriginCity
    • taxService_orderOriginCity

orderInformation. lineItems[].orderOrigin.postalCode

Postal code where you receive the customer’s order.
This
line item
field overrides the corresponding request-level field.
This field is not used for Tax Calculation unless the
orderInformation.lineItems[].orderOrigin.locality
,
orderInformation.lineItems[].orderOrigin.administrativeArea
, and
orderInformation.lineItems[].orderOrigin.country
fields are present.
Must be sent at the line or offer level to be surfaced in the Tax Detail Report.

Specifications

  • Data Type:
    String
  • Data Length:
    10

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].orderOrigin.postalCode
  • SCMP API Field:
    order_origin_zip
  • Simple Order API Fields:
    • item_#_orderOriginPostalCode
    • taxService_orderOriginPostalCode

orderInformation. lineItems[].passenger.email

Passenger's email address, including the full domain name, such as jdoe@example.com.

Specifications

  • Data Type:
    String
  • Data Length:
    255

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].passenger.email
  • SCMP API Field:
    passenger_email
  • Simple Order API Field:
    item_#_passengerEmail

orderInformation. lineItems[].passenger.firstName

Passenger's first name.

Specifications

  • Data Type:
    String
  • Data Length:
    60

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].passenger.firstName
  • SCMP API Field:
    passenger_firstname
  • Simple Order API Field:
    item_#_passengerFirstName

orderInformation. lineItems[].passenger.id

ID of the passenger to whom the ticket was issued.
For example, you can use this field for the frequent flyer number.

Specifications

  • Data Type:
    String
  • Data Length:
    32

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].passenger.id
  • SCMP API Field:
    passenger_id
  • Simple Order API Field:
    item_#_passengerID

orderInformation. lineItems.passenger.lastName

Passenger's last name.

Specifications

  • Data Type:
    String
  • Data Length:
    60

Mapping Information

  • REST API Field:
    orderInformation.lineItems.passenger.lastName
  • SCMP API Field:
    passenger_lastname
  • Simple Order API Field:
    item_#_passengerLastName

orderInformation. lineItems[].passenger.nationality

Passenger's nationality.
Use the two-character ISO country code. .

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].passenger.nationality
  • SCMP API Field:
    passenger_nationality
  • Simple Order API Field:
    item_#_passengerNationality

orderInformation. lineItems[].passenger.phone

Passenger's phone number.
If the order is from outside the US, it is recommended that you include the telephone country code.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].passenger.phone
  • SCMP API Field:
    passenger_phone
  • Simple Order API Field:
    item_#_passengerPhone

orderInformation. lineItems[].passenger.status

Your company's passenger classification, such as with a frequent flyer program.
In this case, you might use values such as standard, gold, or platinum.

Specifications

  • Data Type:
    String
  • Data Length:
    32

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].passenger.status
  • SCMP API Field:
    passenger_status
  • Simple Order API Field:
    item_#_passengerStatus

orderInformation. lineItems[].passenger.type

Passenger classification associated with the price of the ticket.
For example, you might use adult or child.

Specifications

  • Data Type:
    String
  • Data Length:
    32

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].passenger.type
  • SCMP API Field:
    passenger_type
  • Simple Order API Field:
    item_#_passengerType

orderInformation. lineItems[].productCode

Type of product.
This value is used to determine the product category: electronic, handling, physical, service, or shipping. The default value is
default
.
Possible values:
  • adult_content
    : Adult content.
  • coupon
    : Coupon applied to the entire order.
  • default
    : Default value for the product code. The value
    default
    is used when a request message does not include a value for the product code.
  • electronic_good
    : Electronic product other than software.
  • electronic_software
    : Software distributed electronically rather than on disks or other media.
  • gift_certificate
    : Gift certificate.
  • handling_only
    : Fee that you charge your customer to cover your administrative selling costs.
  • service
    : Service that you perform for your customer.
  • shipping_and_handling
    : Handling portion is the fee that you charge your customer to cover your administrative selling costs. Shipping is the charge for shipping the product to your customer.
  • shipping_only
    : Charge for transporting tangible personal property from your location to your customer. You must maintain documentation that clearly establishes the location where the title to the property passed from you to your customer.
  • subscription
    : subscription to a website or other content.
To use the Tax Calculation service, use values listed in the
Tax Product Code Guide
. For information about this document, contact customer support.
For authorizations, when you set this to a value other than
default
or any of the values related to shipping and handling, the
orderInformation.lineItems[].quantity
,
orderInformation.lineItems[].productName
, and
orderInformation.lineItems[].productSku
fields are required.

Specifications

  • Data Type:
    String
  • Data Length:
    255

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].productCode
  • SCMP API Field:
    product_code
  • Simple Order API Field:
    item_#_productCode

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.
  • Chase Paymentech Solutions
    :
    Product Code
  • Elavon Americas
    :
    • Mastercard: Product Code
    • Visa: Discount Per line Item
  • FDC Compass
    :
    Product Code
  • FDC Nashville Global
    :
    Item Product Code
  • GPN
    :
    Product Code
  • OmniPay Direct
    :
    Quantity / Item Quantity
  • RBS WorldPay Atlanta
    :
    Product Code
  • TSYS Acquiring Solutions
    :
    Product Code
  • Visa Platform Connect
    :
    productCode
  • Worldpay VAP
    :
    productCode

orderInformation. lineItems[]. productDescription

Brief description of item.

Specifications

  • Data Type:
    String
  • Data Length:
    256

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].productDescription
  • SCMP API Fields:
    • ap_initiate_product_description
    • product_description
  • Simple Order API Fields:
    • apInitiateService_productDescription
    • item_#_productDescription

orderInformation. lineItems[].productName

Name of product.

Specifications

  • Data Type:
    String
  • Data Length
    • Barclays
      : 35
    • Other processors: 255

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].productName
  • SCMP API Fields:
    • ap_initiate_product_name
    • product_name
  • Simple Order API Fields:
    • apInitiateService_productName
    • item_#_productName

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.
  • Chase Paymentech Solutions
    : Description
  • Elavon Americas
    : Item Description
  • FDC Compass
    : Description
  • FDC Nashville Global
    : Description
  • OmniPay Direct
    : Item Description
  • RBS WorldPay Atlanta
    : Description
  • TSYS Acquiring Solutions
    :
    • Mastercard: Item Description
    • Visa: Item Descriptor
  • Visa Platform Connect
    : productName
  • Worldpay VAP
    : itemDescription

orderInformation. lineItems[].productSKU

Identification code for the product.
Only alphanumeric characters are accepted. Do not include hyphens or other non-alphanumeric characters.

Specifications

  • Data Type:
    String

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].productSKU
  • SCMP API Field:
    merchant_product_sku
  • Simple Order API Field:
    item_#_productSKU

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:
  • Barclays
    : Product Code
  • FDC Nashville Global
    : Item Customer Code

orderInformation. lineItems[].quantity

Quantity of the product.
The default is
1
.

Specifications

  • Data Type:
    Integer
  • Data Length:
    9

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].quantity
  • SCMP API Field:
    quantity
  • Simple Order API Field:
    item_#_quantity

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.
  • American Express Direct
    : Does not apply
  • Barclays
    : Quantity
  • Chase Paymentech Solutions
    : Quantity
  • Elavon Americas
    : Quantity
  • FDC Compass
    : Quantity
  • FDC Nashville Global
    : Item Quantity
  • GPN
    : Item Quantity
  • OmniPay Direct
    : Quantity / Item Quantity
  • RBS WorldPay Atlanta
    : Quantity
  • TSYS Acquiring Solutions
    • Mastercard: Item Quantity
    • Visa: Quantity
  • Visa Platform Connect
    : quantity
  • Worldpay VAP
    : quantity

orderInformation. lineItems[]. referenceDataCode

Code that identifies the value of the corresponding
orderInformation.lineItems[].referenceDataNumber
field.
This field is a pass-though field. This means
Cybersource
does not verify the value or modify it in any way before sending it to the precessor.
Possible values:
  • AN
    : Client-defined asset code
  • MG
    : Manufacturers part number
  • PO
    : Purchase order number
  • SK
    : Supplier stock keeping unit number
  • UP
    : Universal product code
  • VC
    : Supplier catalog number
  • VP
    : Vendor part number

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].referenceDataCode
  • SCMP API Field:
    reference_data_#_code
  • Simple Order API Field:
    item_#_referenceData_#_code

orderInformation. lineItems[]. referenceDataNumber

Reference number. The meaning of this value is defined by the value of the corresponding
orderInformation.lineItems[].referenceDataCode
field.

Specifications

  • Data Type:
    String
  • Data Length:
    • For
      PO
      value: 22
    • For
      VC
      value: 20
    • For all other code values: 30

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].referenceDataNumber
  • SCMP API Field:
    reference_data_#_number
  • Simple Order API Field:
    item_#_referenceData_#_number

orderInformation. lineItems[].restrictedExportCountries[]

List of countries to which the product cannot be exported.
This field is used only when the
processingInformation.actionList
field contains the value
WATCHLIST_SCREENING
.
Use the two-character ISO country codes. .

Specifications

  • Data Type:
    Array of strings
  • Data Length:
    2,147,483,647

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].restrictedExportCountries[]
  • SCMP API Field:
    no_export
  • Simple Order API Field:
    item_#_noExport

orderInformation. lineItems[]. shippingAddress1

Address to which the item will be shipped.

Specifications

  • Data Type:
    String
  • Data Length:
    50

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].shippingAddress1
  • SCMP API Field:
    shipping_address1
  • Simple Order API Field:
    item_#_shippingAddress1

orderInformation. lineItems[]. shippingAddress2

Address to which the item will be shipped.

Specifications

  • Data Type:
    String
  • Data Length:
    128

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].shippingAddress2
  • SCMP API Field:
    shipping_address2
  • Simple Order API Field:
    item_#_shippingAddress2

orderInformation. lineItems[].shippingCity

City to which the item will be shipped.

Specifications

  • Data Type:
    String
  • Data Length:
    128

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].shippingCity
  • SCMP API Field:
    shipping_city
  • Simple Order API Field:
    item_#_shippingCity

orderInformation. lineItems[].shippingCountryCode

Country to which the item will be shipped.

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].shippingCountryCode
  • SCMP API Field:
    shipping_country_code
  • Simple Order API Field:
    item_#_shippingCountryCode

orderInformation. lineItems.shippingDestinationTypes

Item's shipping destination type.
Example
: Commercial, residential, store

Specifications

  • Data Type:
    String
  • Data Length:
    50

Mapping Information

  • REST API Field:
    orderInformation.lineItems.shippingDestinationTypes
  • SCMP API Field:
    shipping_destination_types
  • Simple Order API Field:
    item_#_shippingDestinationTypes

orderInformation. lineItems[].shippingFirstName

First name of the shipping recipient.

Specifications

  • Data Type:
    String
  • Data Length:
    128

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].shippingFirstName
  • SCMP API Field:
    shipping_first_name
  • Simple Order API Field:
    item_#_shippingFirstName

orderInformation. lineItems[].shippingLastName

Last name of the shipping recipient.

Specifications

  • Data Type:
    String
  • Data Length:
    128

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].shippingLastName
  • SCMP API Field:
    shipping_last_name
  • Simple Order API Field:
    item_#_shippingLastName

orderInformation. lineItems[].shippingMiddleName

Middle name of the shipping recipient.

Specifications

  • Data Type:
    String
  • Data Length:
    128

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].shippingMiddleName
  • SCMP API Field:
    shipping_middle_name
  • Simple Order API Field:
    item_#_shippingMiddleName

orderInformation. lineItems[].shippingPhone

Recipient's phone number.

Specifications

  • Data Type:
    Integer
  • Data Length:
    20

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].shippingPhone
  • SCMP API Field:
    shipping_phone
  • Simple Order API Field:
    item_#_shippingPhone

orderInformation. lineItems[].shippingPostalCode

Recipient's postal code.

Specifications

  • Data Type:
    String
  • Data Length:
    16

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].shippingPostalCode
  • SCMP API Field:
    shipping_postal_code
  • Simple Order API Field:
    item_#_shippingPostalCode

orderInformation. lineItems[].shippingState

State to which the item will be shipped.

Specifications

  • Data Type:
    String
  • Data Length:
    3

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].shippingState
  • SCMP API Field:
    shipping_state
  • Simple Order API Field:
    item_#_shippingState

orderInformation. lineItems[].taxableAmount

Taxable amount for the item.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Fields:
    orderInformation.lineItems[].taxableAmount
  • SCMP API Field:
    tax_taxable_amount0..N
  • Simple Order API Field:
    taxReply_item_#_taxableAmount

orderInformation. lineItems[].taxAmount

Total tax to apply to the product.
Specify the value in US English characters. The amount cannot be negative. The tax amount and the
unit price
must be in the same currency.
This field is available only on the
American Express Direct
,
Barclays
,
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
FDMS South
,
FDC Nashville Global
,
FDMS Nashville
,
GPN
,
OmniPay Direct
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
,
Visa Platform Connect
, and
Worldpay VAP
processors.
When you include this field, the Tax Calculation service does not calculate tax for the offer. Instead, it returns the value of the
orderInformation.lineItems.taxAmount
field in the reply message.
The tax amount value is additive as shown in this example.
Example:
This example uses a two-exponent currency such as USD:
  1. You include these
    offers
    in 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
  2. 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 US, Canadian, international tax, and value-added taxes.
When you want to include
orderInformation.lineItems[].taxAmount
.
For more information, see the
Tax Calculation Developer 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.
  • American Express Direct
    : Does not apply
  • Barclays
    : Tax Amount
  • Chase Paymentech Solutions
    : Tax Amount
  • Elavon Americas
    : VAT / Tax Amount
  • FDC Compass
    : Tax Amount
  • FDC Nashville Global
    : Local Tax Amount
  • FDMS Nashville
    : Does not apply
  • FDMS South
    : Does not apply
  • GPN
    • Level II: Amount 2
    • Level III: Tax Amount N
  • GPX
    : localTax Amount
  • OmniPay Direct
    : Tax Amount / Total Tax Amount
  • RBS WorldPay Atlanta
    : Tax Amount
  • Visa Platform Connect
    : localTax Amount
  • TSYS Acquiring Solutions
    • Mastercard: Tax Amount
    • Visa: VAT / Tax Amount
  • Worldpay VAP
    : taxAmount

orderInformation. lineItems[].taxAppliedAfterDiscount

Flag to indicate how you handle discount at the line item level.
This field is available only for the
Visa Platform Connect
processor.
Possible values:
  • 0
    : no line level discount provided
  • 1
    : tax was calculated on the post-discount line item total
  • 2
    : tax was calculated on the pre-discount line item total
Visa inserts a 0 (zero) value if an invalid value is included in this field.
This field relates to the value in the
orderInformation.amountDetails.discountAmount
field.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].taxAppliedAfterDiscount
  • SCMP API Field:
    discount_management_indicator
  • Simple Order API Field:
    item_#_discountManagementIndicator

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:
  • Visa Platform Connect
    : discountManagementIndicator

orderInformation. lineItems[].taxDetails[].amount

Amount collected for tax.
Elavon Americas
For Mastercard, do not set this field to 0 (zero).
FDC Nashville Global
Visa: VAT or other tax amount.
Mastercard: Tax amount collected for a special type of tax. Do not set this field to 0 (zero).

Specifications

  • Data Type:
    String
  • Data Length:
    • American Express Direct
      7 (Canadian Dollars), 9 (U.S. Dollars)
    • Elavon Americas
      10
    • Worldpay VAP
      8
    • FDC Nashville Global
      13
    • TSYS Acquiring Solutions
      13
    • All other processors:
      15

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].taxDetails[].amount
  • SCMP API Fields:
    • alternate_tax_amount
    • local_tax
    • national_tax
    • other_tax#_amount
    • tax_city_taxN
    • tax_county_taxN
    • tax_country_taxN
    • tax_district_taxN
    • tax_special_tax0...N
    • tax_state_taxN
    • tax_tax_amountN
  • Simple Order API Fields:
    • item_#_alternateTaxAmount
    • item_#_localTax
    • item_#_nationalTax
    • item_#_otherTax_#_amount
    • item_#_otherTax_localTaxAmount
    • taxReply_item_#_cityTaxAmount
    • taxReply_item_#_countyTaxAmount
    • taxReply_item_#_countryTaxAmount
    • taxReply_item_#_districtTaxAmount
    • taxReply_item_#_specialTaxAmount
    • taxReply_item_#_stateTaxAmount
    • taxReply_item_#_totalTaxAmount

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:
  • American Express Direct
    : Does not apply
  • Elavon Americas
    : Sales Tax Amount
  • FDC Nashville Global
    : Item Other Tax Amount and Item Local Tax Amount
  • Worldpay VAP
    : taxAmount
  • TSYS Acquiring Solutions
    : Local Tax

orderInformation. lineItems[].taxDetails[].applied

A flag that indicates whether an alternative tax amount (
orderInformation.amountDetails.taxDetails[].amount
) is included in the request.
Possible values for this field:
  • false
    : Alternate tax amount is not included in the request
  • true
    : Alternate tax amount is included in the request

Specifications

  • Data Type:
    Boolean

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].taxDetails[].applied
  • SCMP API Field:
    alternate_tax_amount_indicator
  • Simple Order API Fields:
    • item_#_alternateTaxType
    • otherTax_alternateTaxIndicator

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:
  • Elavon Americas
    : National /Alternate Tax Included
  • FDC Nashville Global
    : Other Tax Indicator
  • RBS WorldPay Atlanta
    : Alternate Tax Indicator
  • TSYS Acquiring Solutions
    : Alternate Tax Amount Indicator

orderInformation. lineItems[].taxDetails[].code

Flag that indicates whether local sales tax is included in the order total.
Possible values:
  • 0
    : local sales tax not included
  • 1
    : local sales tax included
  • 2
    : tax exempt order
For Mastercard: Defines tax categories for domestic processing in certain locations.
Flag that indicates the type of tax collected for
orderInformation.lineItems[].taxDetails[].amount
.
Possible values:
  • 00
    : unknown
  • 01
    : federal or national sales tax
  • 02
    : states sales tax
  • 03
    : city sales tax
  • 04
    : local sales tax
  • 05
    : municipal sales tax
  • 06
    : other tax
  • 10
    : value-added tax (VAT)
  • 11
    : goods and services tax (GST)
  • 12
    : provincial sales tax
  • 20
    : room tax
  • 21
    : occupancy tax
  • 22
    : energy tax

Specifications

  • Data Type:
    String
  • Data Length:
    4

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].taxDetails[].code
  • SCMP API Fields:
    • alternate_tax_type_applied
    • local_tax_indicator
  • Simple Order API Fields:
    • item_#_alternateTaxTypeApplied
    • otherTax_localTaxIndicator

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:
  • Elavon Americas
    : Sales Tax Included
  • FDC Nashville Global
    : Item Tax Type Applied
  • OmniPay Direct
    : Local Tax Included
  • TSYS Acquiring Solutions
    : Local Tax Included Flag

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

This 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
    : Does not apply
  • GPN
    : Tax Rate N
  • OmniPay Direct
    : VAT / TAx Rate (Freight or Shipping)
  • Worldpay VAP
    : taxRate

orderInformation. lineItems[].taxDetails[].taxID

Your tax ID number to use for the alternate tax amount.

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].taxDetails[].taxID
  • SCMP API Field:
    alternate_tax_id
  • Simple Order API Field:
    item_#_alternateTaxID

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:
  • Elavon Americas
    (Field name for Mastercard): Tax Amount
  • FDC Nashville Global
    : Tax Amount 1 Tax ID
  • RBS WorldPay Atlanta
    : Alternate Tax ID
  • TSYS Acquiring Solutions
    : Alternate Tax Identifier
  • Worldpay VAP
    : cardAcceptorTaxId

orderInformation. lineItems[].taxDetails[].type

Description of the tax applied for the item.
This field is part of an array and can include one or more tax types along with the amounts for each tax. For each tax type, you must also include the
orderInformation.lineItems[].taxDetails[].amount
field. For each tax, the two fields should be added in the following form:
"orderInformation": { "lineItems":[ "taxDetails":[ "type": "city", "amount": "5.14" ] ] }
Possible values include:
  • city
  • county
  • state
  • national
  • special

Specifications

  • Data Type:
    String
  • Data Length:
    15

Mapping Information

  • REST API Field:
    orderInformation.lineItems.taxDetails.type
  • SCMP API Fields:
    • tax_city_tax0...N
    • tax_county_tax0...N
    • tax_district_tax0...N
    • tax_state_tax0...N
    • tax_tax_amount0...N
  • Simple Order API Fields:
    • taxReply_item_#_cityTaxAmount
    • taxReply_item_#_countyTaxAmount
    • taxReply_item_#_districtTaxAmount
    • taxReply_item_#_stateTaxAmount
    • taxReply_item_#_totalTaxAmount

orderInformation. lineItems[].taxRate

Tax rate applied to the item.
This field is available only on the
American Express Direct
,
Barclays
,
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
, and
Visa Platform Connect
processors.
American Express Direct
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
, and
Visa Platform Connect
For transactions on Visa payment cards, the valid range is from
0.01
(1%) to
0.99
(99%). Only whole percentage values accepted; values with additional decimal places will be truncated.
For other transactions, the valid range is from
0.00
(0%) to
99.99
(99.99%). Values with more than two digits beyond the decimal point will be truncated.
  • 60%:
    60.00
  • 25.5%:
    25.50
  • 33.33%:
    33.33
Barclays
The valid range is from
0.00
(0%) to
100.00
(100%), expressed as a whole number with decimals.
For example, 20.00 = 20% tax rate.
Chase Paymentech Solutions
,
Elavon Americas
, and
FDC Compass
For transactions on Mastercard payment cards, the valid range is from
0.00001
(0.001%) to
0.99999
(99.999%).
  • 60%:
    0.6000
  • 25.5%:
    0.2550
  • 33.33%:
    0.3333
For transactions on Visa payment cards, the valid range is from
0.01
(1%) to
0.99
(99%).
  • 60%:
    0.60
  • 25%:
    0.25
  • 33%:
    0.33

Specifications

  • Data Type:
    String
  • Data Length
    • Barclays
      : 6
    • Chase Paymentech Solutions
      : 7 (Mastercard), 4 (Visa)
    • Elavon Americas
      : 5 (Mastercard), 4 (Visa)
    • FDC Compass
      : 7 (Mastercard), 4 (Visa)
    • TSYS Acquiring Solutions
      : 6
    • Other processors: 4

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].taxRate
  • SCMP API Field:
    tax_rate
  • Simple Order API Field:
    item_#_taxRate

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:
  • American Express Direct
    : Does not apply
  • Chase Paymentech Solutions
    : Tax Rate
  • Elavon Americas
    :
    • Mastercard: Tax Rate Applied
    • Visa: VAT/Tax Rate
  • FDC Compass
    : Tax Rate
  • RBS WorldPay Atlanta
    : Tax Rate
  • TSYS Acquiring Solutions
    :
    • Mastercard: Tax Rate Applied
    • Visa: VAT/Tax Rate
  • Visa Platform Connect
    : taxRate

orderInformation. lineItems[].taxStatusIndicator

Status for exemption from sales and use tax.
This field is available only on the
American Express Direct
processor.
This field is a pass-though field, which means
Cybersource
does not verify the value or modify it in any way before sending it to the processor.

Specifications

  • Data Type:
    String
  • Data Length:
    1

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].taxStatusIndicator
  • SCMP API Field:
    tax_status_indicator
  • Simple Order API Field:
    item_#_taxStatusIndicator

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:
  • American Express Direct
    : Does not apply

orderInformation. lineItems[].taxTypeCode

Type of tax applied to the item.
This field is available only on the
Barclays
,
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
RBS WorldPay Atlanta
, and
TSYS Acquiring Solutions
processors.
Barclays
Possible values:
  • S
    : Single standard rate
  • AA
    : Reduced rate AA
  • BB
    : Reduced rate BB
  • CC
    : Reduced rate CC
  • DD
    : Reduced rate DD
  • E
    : Exempt
  • Z
    : Zero rated
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
RBS WorldPay Atlanta
, and
TSYS Acquiring Solutions
Possible values:
  • 0000
    : unknown tax type
  • 0001
    : federal/national sales tax
  • 0002
    : state sales tax
  • 0003
    : city sales tax
  • 0004
    : local sales tax
  • 0005
    : municipal sales tax
  • 0006
    : other tax
  • 0010
    : value-added tax (VAT)
  • 0011
    : goods and services tax
  • 0012
    : provincial sales tax
  • 0013
    : harmonized sales tax
  • 0014
    : Quebec sales tax (QST)
  • 0020
    : room tax
  • 0021
    : occupancy tax
  • 0022
    : energy tax
  • blank: tax not supported on line item

Specifications

  • Data Type:
    String
  • Data Length
    • Barclays
      : 2
    • Chase Paymentech Solutions
      : 4 numeric
    • Elavon Americas
      : 4 numeric
    • FDC Compass
      : 4 numeric
    • RBS WorldPay Atlanta
      : 4 numeric
    • TSYS Acquiring Solutions
      : 4 numeric

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].taxTypeCode
  • SCMP API Field:
    tax_type_applied
  • Simple Order API Field:
    item_#_taxTypeApplied

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:
  • Chase Paymentech Solutions
    : Tax Type Applied
  • Elavon Americas
    : Tax Type Applied
  • FDC Compass
    : Tax Type Applied
  • RBS WorldPay Atlanta
    : Tax Type
  • TSYS Acquiring Solutions
    : Tax Type Applied

orderInformation. lineItems[].totalAmount

Total amount for the item, calculated as:
(unit price ✕ quantity)
.
This field is available only on the
Barclays
,
Elavon Americas
,
FDC Compass
,
OmniPay Direct
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
,
Visa Platform Connect
, and
Worldpay VAP
processors.
Barclays
Must be numeric with two exponents.
Chase Paymentech Solutions
Do not use all zeros or spaces in Mastercard transactions.
FDC Compass
Do not use all zeroes or spaces in Mastercard transactions.
RBS WorldPay Atlanta
Do not use all zeros or spaces in Mastercard transactions.

Specifications

  • Data Type:
    String
  • Data Length:
    • Barclays
      10 (Mastercard), 18 (Visa)
    • Chase Paymentech Solutions
      : 10 (Mastercard), 13 (Visa)
    • Elavon Americas
      : 9 (Mastercard), 12 (Visa)
    • FDC Compass
      : 10 (Mastercard), 13 (Visa)
    • OmniPay Direct
      : 12
    • RBS WorldPay Atlanta
      : 12
    • TSYS Acquiring Solutions
      : 10 (Mastercard), 13 (Visa)
    • Visa Platform Connect
      : 12
    • Worldpay VAP
      : 8
    • Other processors: 12

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].totalAmount
  • SCMP API Field:
    total_amount
  • Simple Order API Field:
    item_#_totalAmount

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:
  • Barclays
    Line Item Total
  • Chase Paymentech Solutions
    : Line Item Total
  • Elavon Americas
    • Mastercard: Extended Item Amount
    • Visa: Line Item Total
  • FDC Compass
    : Line Item Total
  • OmniPay Direct
    : Line Item total / Extended Item Amount
  • RBS WorldPay Atlanta
    : Line Total
  • TSYS Acquiring Solutions
    • Mastercard: Extended Item Amount
    • Visa: Line Item Total
  • Visa Platform Connect
    : totalAmount
  • Worldpay VAP
    : lineItemTotal

orderInformation. lineItems[].typeOfSupply

Code indicating whether the purchase is categorized as goods or services.
This field is available only for the
Visa Platform Connect
processor.
Possible values:
  • 00
    : Goods
  • 01
    : Services

Specifications

  • Data Type:
    String
  • Data Length:
    2

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].typeOfSupply
  • SCMP API Field:
    type_of_supply
  • Simple Order API Field:
    item_#_typeOfSupply

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:
  • Visa Platform Connect
    : typeOfSupply

orderInformation. lineItems[].unitOfMeasure

Code that specifies the unit of measure for the item.
Do not use all zeros or spaces in this field.
This field is available only for the
American Express Direct
,
Barclays
,
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
FDC Nashville Global
,
GPN
,
OmniPay Direct
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
,
Visa Platform Connect
, and
Worldpay VAP
processors.
This processor has specific requirements:
For
American Express Direct
, see the EDI codes for units of measurement at el355.htm.

Specifications

  • Data Type:
    String
  • Data Length
    • American Express Direct
      : 2
    • Barclays
      : 80
    • Chase Paymentech Solutions
      : 3 (Mastercard), 12 (Visa)
    • Elavon Americas
      : 3 (Mastercard), 12 (Visa)
    • FDC Compass
      : 3 (Mastercard), 12 (Visa)
    • FDC Nashville Global
      : 12
    • GPN
      : 12
    • OmniPay Direct
      : 12
    • RBS WorldPay Atlanta
      : 12
    • TSYS Acquiring Solutions
      : 12
    • Visa Platform Connect
      : 12
    • Worldpay VAP
      : 12
    • Other processors: 12

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].unitOfMeasure
  • SCMP API Field:
    unit_of_measure
  • Simple Order API Field:
    item_#_unitOfMeasure

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:
  • American Express Direct
    : Does not apply
  • Barclays
    : Unit of Measure
  • Chase Paymentech Solutions
    : Unit of Measure
  • Elavon Americas
    : Unit of Measure
  • FDC Compass
    : Unit of Measure
  • FDC Nashville Global
    : Item Bulk / Unit of Measure
  • GPN
    : Unit of Measure
  • OmniPay Direct
    : Unit of Measure Code / Item Unit of Measure
  • RBS WorldPay Atlanta
    : Unit of Measure
  • TSYS Acquiring Solutions
    :
    • Mastercard: Item Unit of Measure
    • Visa: Unit of Measure/Code
  • Visa Platform Connect
    : unitOfMeasure
  • Worldpay VAP
    : unitOfMeasure

orderInformation. lineItems[].unitPrice

Per-item price of the product.
This is an item-level field.
This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. The amount is truncated to the correct number of decimal places.
This field is available only on the
American Express Direct
,
Barclays
,
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
FDC Nashville Global
,
FDMS Nashville
,
FDMS South
,
GPN
,
OmniPay Direct
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
,
Visa Platform Connect
, and
Worldpay VAP
processors.
IMPORTANT
Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.
Barclays
Value must be numeric with two exponents.
Visa Platform Connect
Limit authorization and capture amounts to 999999999999 (twelve 9s).
DCC with a Third-Party Provider
: Set this field to the converted amount that was returned by the DCC provider. You must include either this field or
orderInformation.amountDetails.totalAmount
in a request.
Zero Amount Authorizations
: If your processor supports zero amount authorizations, you can set this field to
0
for an authorization to find out whether the card is lost or stolen.
Level III transaction
: This value cannot be zero (0).

Specifications

  • Data Type:
    String
  • Data Length
    • American Express Direct
      : 8 (CAD), 10 (USD)
    • Barclays
      : 8 (for Mastercard), 18 (for Visa)
    • Chase Paymentech Solutions
      : 13 (USD)
    • FDC Compass
      : 13 (USD)
    • FDC Nashville Global
      : 13 (USD)
    • FDMS Nashville
      : 15 (USD)
    • RBS WorldPay Atlanta
      : 8 (Mastercard), 10 (Visa)
    • Other processors: 12

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].unitPrice
  • SCMP API Field:
    amount
  • Simple Order API Field:
    item_#_unitPrice

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.
  • American Express Direct
    : Does not apply
  • Barclays
    : Unit Price
  • Chase Paymentech Solutions
    : Unit Cost
  • Elavon Americas
    : Unit Cost
  • FDC Compass
    : Unit Cost
  • FDC Nashville Global
    : Item Unit Cost
  • FDMS Nashville
    : Does not apply
  • FDMS South
    : Does not apply
  • GPN
    : Unit Price
  • OmniPay Direct
    : Unit Cost/Unit Price
  • RBS WorldPay Atlanta
    : Unit Cost
  • TSYS Acquiring Solutions
    : Unit Cost
  • Visa Platform Connect
    : unitPrice
  • Worldpay VAP
    : unitCost

orderInformation. lineItems[].weight

Weight of the item.
This field is available only on the
American Express Direct
processor.

Specifications

  • Data Type:
    String
  • Data Length:
    9

Mapping Information

  • REST API Field:
    orderInformation.lineItems[].weight
  • SCMP API Field:
    weight_amount
  • Simple Order API Field:
    item_#_weightAmount

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:
  • American Express Direct
    : Does not apply

orderInformation. lineItems[].weightIdentifier

Type of weight.
This field is available only for the
American Express Direct
processor.
Possible values:
  • B
    : Billed weight
  • N
    : Actual net weight

Specifications

  • Data Type:</