Skip to content

Latest commit

 

History

History
26 lines (23 loc) · 6.42 KB

Ptsv2paymentsOrderInformationAmountDetails.md

File metadata and controls

26 lines (23 loc) · 6.42 KB

CyberSource.Ptsv2paymentsOrderInformationAmountDetails

Properties

Name Type Description Notes
totalAmount String Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in Credit Card Services Using the SCMP API. [optional]
currency String Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. [optional]
discountAmount String Total discount amount applied to the order. For processor-specific information, see the order_discount_amount field in Level II and Level III Processing Using the SCMP API. [optional]
dutyAmount String Total charges for any import or export duties included in the order. For processor-specific information, see the duty_amount field in Level II and Level III Processing Using the SCMP API. [optional]
taxAmount String Total tax amount for all the items in the order. For processor-specific information, see the total_tax_amount field in Level II and Level III Processing Using the SCMP API. [optional]
nationalTaxIncluded String Flag that indicates whether a national tax is included in the order total. Possible values: - 0: national tax not included - 1: national tax included For processor-specific information, see the national_tax_indicator field in Level II and Level III Processing Using the SCMP API. [optional]
taxAppliedAfterDiscount String Flag that indicates how the merchant manages discounts. Possible values: - 0: no invoice level discount included - 1: tax calculated on the postdiscount invoice total - 2: tax calculated on the prediscount invoice total For processor-specific information, see the order_discount_management_indicator field in Level II and Level III Processing Using the SCMP API. [optional]
taxAppliedLevel String Flag that indicates how you calculate tax. Possible values: - 0: net prices with tax calculated at line item level - 1: net prices with tax calculated at invoice level - 2: gross prices with tax provided at line item level - 3: gross prices with tax provided at invoice level - 4: no tax applies on the invoice for the transaction For processor-specific information, see the tax_management_indicator field in Level II and Level III Processing Using the SCMP API. [optional]
taxTypeCode String For tax amounts that can be categorized as one tax type. This field contains the tax type code that corresponds to the entry in the lineItems.taxAmount field. Possible values: - 056: sales tax (U.S only) - TX~: all taxes (Canada only) Note ~ = space. For processor-specific information, see the total_tax_type_code field in Level II and Level III Processing Using the SCMP API. [optional]
freightAmount String Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the totalAmount field. For processor-specific information, see the freight_amount field in Level II and Level III Processing Using the SCMP API. [optional]
foreignAmount String Converted amount returned by the DCC service. For processor-specific information, see the foreign_amount field in Credit Card Services Using the SCMP API. [optional]
foreignCurrency String Billing currency returned by the DCC service. For processor-specific information, see the foreign_currency field in Credit Card Services Using the SCMP API. [optional]
exchangeRate String Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For processor-specific information, see the exchange_rate field in Credit Card Services Using the SCMP API. [optional]
exchangeRateTimeStamp String Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space. For processor-specific information, see the exchange_rate_timestamp field in Credit Card Services Using the SCMP API. [optional]
surcharge Ptsv2paymentsOrderInformationAmountDetailsSurcharge [optional]
settlementAmount String This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder’s account. [optional]
settlementCurrency String This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. [optional]
amexAdditionalAmounts [Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts] [optional]
taxDetails [Ptsv2paymentsOrderInformationAmountDetailsTaxDetails] [optional]