Riskv1decisionsOrderInformationLineItems (cybersource-rest-client-java 0.0.53 API)

java.lang.Object
- Model.Riskv1decisionsOrderInformationLineItems

public class Riskv1decisionsOrderInformationLineItems
extends Object

Riskv1decisionsOrderInformationLineItems

Constructor Summary

Constructors
Constructor and Description

Riskv1decisionsOrderInformationLineItems()

Constructors
Constructor and Description
`Riskv1decisionsOrderInformationLineItems()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Riskv1decisionsOrderInformationLineItems`	`addAllowedExportCountriesItem(String allowedExportCountriesItem)`
`Riskv1decisionsOrderInformationLineItems`	`addRestrictedExportCountriesItem(String restrictedExportCountriesItem)`
`Riskv1decisionsOrderInformationLineItems`	`allowedExportCountries(List<String> allowedExportCountries)`
`Riskv1decisionsOrderInformationLineItems`	`distributorProductSku(String distributorProductSku)`
`boolean`	`equals(Object o)`
`List<String>`	`getAllowedExportCountries()` Get allowedExportCountries
`String`	`getDistributorProductSku()` Product’s identifier code.
`Boolean`	`getGift()` This field is only used in DM service.
`Integer`	`getGiftCardCurrency()` When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase.
`Ptsv2paymentsOrderInformationPassenger`	`getPassenger()` Get passenger
`String`	`getProductCode()` Type of product.
`String`	`getProductDescription()` Brief description of item.
`String`	`getProductName()` For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling.
`String`	`getProductRisk()` Indicates the level of risk for the product.
`String`	`getProductSKU()` Product identifier code.
`Integer`	`getQuantity()` Number of units for this order.
`List<String>`	`getRestrictedExportCountries()` Get restrictedExportCountries
`String`	`getShippingDestinationTypes()` Destination to where the item will be shipped.
`String`	`getTaxAmount()` Total tax to apply to the product.
`String`	`getTotalAmount()` Total amount for the item.
`String`	`getUnitPrice()` Per-item price of the product.
`Riskv1decisionsOrderInformationLineItems`	`gift(Boolean gift)`
`Riskv1decisionsOrderInformationLineItems`	`giftCardCurrency(Integer giftCardCurrency)`
`int`	`hashCode()`
`Riskv1decisionsOrderInformationLineItems`	`passenger(Ptsv2paymentsOrderInformationPassenger passenger)`
`Riskv1decisionsOrderInformationLineItems`	`productCode(String productCode)`
`Riskv1decisionsOrderInformationLineItems`	`productDescription(String productDescription)`
`Riskv1decisionsOrderInformationLineItems`	`productName(String productName)`
`Riskv1decisionsOrderInformationLineItems`	`productRisk(String productRisk)`
`Riskv1decisionsOrderInformationLineItems`	`productSKU(String productSKU)`
`Riskv1decisionsOrderInformationLineItems`	`quantity(Integer quantity)`
`Riskv1decisionsOrderInformationLineItems`	`restrictedExportCountries(List<String> restrictedExportCountries)`
`void`	`setAllowedExportCountries(List<String> allowedExportCountries)`
`void`	`setDistributorProductSku(String distributorProductSku)`
`void`	`setGift(Boolean gift)`
`void`	`setGiftCardCurrency(Integer giftCardCurrency)`
`void`	`setPassenger(Ptsv2paymentsOrderInformationPassenger passenger)`
`void`	`setProductCode(String productCode)`
`void`	`setProductDescription(String productDescription)`
`void`	`setProductName(String productName)`
`void`	`setProductRisk(String productRisk)`
`void`	`setProductSKU(String productSKU)`
`void`	`setQuantity(Integer quantity)`
`void`	`setRestrictedExportCountries(List<String> restrictedExportCountries)`
`void`	`setShippingDestinationTypes(String shippingDestinationTypes)`
`void`	`setTaxAmount(String taxAmount)`
`void`	`setTotalAmount(String totalAmount)`
`void`	`setUnitPrice(String unitPrice)`
`Riskv1decisionsOrderInformationLineItems`	`shippingDestinationTypes(String shippingDestinationTypes)`
`Riskv1decisionsOrderInformationLineItems`	`taxAmount(String taxAmount)`
`String`	`toString()`
`Riskv1decisionsOrderInformationLineItems`	`totalAmount(String totalAmount)`
`Riskv1decisionsOrderInformationLineItems`	`unitPrice(String unitPrice)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Riskv1decisionsOrderInformationLineItems
```
public Riskv1decisionsOrderInformationLineItems()
```
- Method Detail
  - totalAmount
```
public Riskv1decisionsOrderInformationLineItems totalAmount(String totalAmount)
```
  - getTotalAmount
```
public String getTotalAmount()
```
    Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123
    
    Returns:
    
    totalAmount
  - setTotalAmount
```
public void setTotalAmount(String totalAmount)
```
  - unitPrice
```
public Riskv1decisionsOrderInformationLineItems unitPrice(String unitPrice)
```
  - getUnitPrice
```
public String getUnitPrice()
```
    Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15)
    
    Returns:
    
    unitPrice
  - setUnitPrice
```
public void setUnitPrice(String unitPrice)
```
  - quantity
```
public Riskv1decisionsOrderInformationLineItems quantity(Integer quantity)
```
  - getQuantity
```
public Integer getQuantity()
```
    Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. minimum: 1 maximum: 999999999
    
    Returns:
    
    quantity
  - setQuantity
```
public void setQuantity(Integer quantity)
```
  - giftCardCurrency
```
public Riskv1decisionsOrderInformationLineItems giftCardCurrency(Integer giftCardCurrency)
```
  - getGiftCardCurrency
```
public Integer getGiftCardCurrency()
```
    When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf) For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
    
    Returns:
    
    giftCardCurrency
  - setGiftCardCurrency
```
public void setGiftCardCurrency(Integer giftCardCurrency)
```
  - productSKU
```
public Riskv1decisionsOrderInformationLineItems productSKU(String productSKU)
```
  - getProductSKU
```
public String getProductSKU()
```
    Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling.
    
    Returns:
    
    productSKU
  - setProductSKU
```
public void setProductSKU(String productSKU)
```
  - productRisk
```
public Riskv1decisionsOrderInformationLineItems productRisk(String productRisk)
```
  - getProductRisk
```
public String getProductRisk()
```
    Indicates the level of risk for the product. This field can contain one of the following values: - `low`: The product is associated with few chargebacks. - `normal`: The product is associated with a normal number of chargebacks. - `high`: The product is associated with many chargebacks.
    
    Returns:
    
    productRisk
  - setProductRisk
```
public void setProductRisk(String productRisk)
```
  - productDescription
```
public Riskv1decisionsOrderInformationLineItems productDescription(String productDescription)
```
  - getProductDescription
```
public String getProductDescription()
```
    Brief description of item.
    
    Returns:
    
    productDescription
  - setProductDescription
```
public void setProductDescription(String productDescription)
```
  - productName
```
public Riskv1decisionsOrderInformationLineItems productName(String productName)
```
  - getProductName
```
public String getProductName()
```
    For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes.
    
    Returns:
    
    productName
  - setProductName
```
public void setProductName(String productName)
```
  - productCode
```
public Riskv1decisionsOrderInformationLineItems productCode(String productCode)
```
  - getProductCode
```
public String getProductCode()
```
    Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don’t send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you’ve indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].
    
    Returns:
    
    productCode
  - setProductCode
```
public void setProductCode(String productCode)
```
  - gift
```
public Riskv1decisionsOrderInformationLineItems gift(Boolean gift)
```
  - getGift
```
public Boolean getGift()
```
    This field is only used in DM service. Determines whether to assign risk to the order if the billing and shipping addresses specify different cities, states, or countries. This field can contain one of the following values: - true: Orders are assigned only slight additional risk if billing and shipping addresses are different. - false: Orders are assigned higher additional risk if billing and shipping addresses are different.
    
    Returns:
    
    gift
  - setGift
```
public void setGift(Boolean gift)
```
  - distributorProductSku
```
public Riskv1decisionsOrderInformationLineItems distributorProductSku(String distributorProductSku)
```
  - getDistributorProductSku
```
public String getDistributorProductSku()
```
    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.
    
    Returns:
    
    distributorProductSku
  - setDistributorProductSku
```
public void setDistributorProductSku(String distributorProductSku)
```
  - passenger
```
public Riskv1decisionsOrderInformationLineItems passenger(Ptsv2paymentsOrderInformationPassenger passenger)
```
  - getPassenger
```
public Ptsv2paymentsOrderInformationPassenger getPassenger()
```
    Get passenger
    
    Returns:
    
    passenger
  - setPassenger
```
public void setPassenger(Ptsv2paymentsOrderInformationPassenger passenger)
```
  - shippingDestinationTypes
```
public Riskv1decisionsOrderInformationLineItems shippingDestinationTypes(String shippingDestinationTypes)
```
  - getShippingDestinationTypes
```
public String getShippingDestinationTypes()
```
    Destination to where the item will be shipped. Example: Commercial, Residential, Store
    
    Returns:
    
    shippingDestinationTypes
  - setShippingDestinationTypes
```
public void setShippingDestinationTypes(String shippingDestinationTypes)
```
  - taxAmount
```
public Riskv1decisionsOrderInformationLineItems taxAmount(String taxAmount)
```
  - getTaxAmount
```
public String getTaxAmount()
```
    Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine
    
    Returns:
    
    taxAmount
  - setTaxAmount
```
public void setTaxAmount(String taxAmount)
```
  - allowedExportCountries
```
public Riskv1decisionsOrderInformationLineItems allowedExportCountries(List<String> allowedExportCountries)
```
  - addAllowedExportCountriesItem
```
public Riskv1decisionsOrderInformationLineItems addAllowedExportCountriesItem(String allowedExportCountriesItem)
```
  - getAllowedExportCountries
```
public List<String> getAllowedExportCountries()
```
    Get allowedExportCountries
    
    Returns:
    
    allowedExportCountries
  - setAllowedExportCountries
```
public void setAllowedExportCountries(List<String> allowedExportCountries)
```
  - restrictedExportCountries
```
public Riskv1decisionsOrderInformationLineItems restrictedExportCountries(List<String> restrictedExportCountries)
```
  - addRestrictedExportCountriesItem
```
public Riskv1decisionsOrderInformationLineItems addRestrictedExportCountriesItem(String restrictedExportCountriesItem)
```
  - getRestrictedExportCountries
```
public List<String> getRestrictedExportCountries()
```
    Get restrictedExportCountries
    
    Returns:
    
    restrictedExportCountries
  - setRestrictedExportCountries
```
public void setRestrictedExportCountries(List<String> restrictedExportCountries)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Riskv1decisionsOrderInformationLineItems

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Riskv1decisionsOrderInformationLineItems

Method Detail

totalAmount

getTotalAmount

setTotalAmount

unitPrice

getUnitPrice

setUnitPrice

quantity

getQuantity

setQuantity

giftCardCurrency

getGiftCardCurrency

setGiftCardCurrency

productSKU

getProductSKU

setProductSKU

productRisk

getProductRisk

setProductRisk

productDescription

getProductDescription

setProductDescription

productName

getProductName

setProductName

productCode

getProductCode

setProductCode

gift

getGift

setGift

distributorProductSku

getDistributorProductSku

setDistributorProductSku

passenger

getPassenger

setPassenger

shippingDestinationTypes

getShippingDestinationTypes

setShippingDestinationTypes

taxAmount

getTaxAmount

setTaxAmount

allowedExportCountries

addAllowedExportCountriesItem

getAllowedExportCountries

setAllowedExportCountries

restrictedExportCountries

addRestrictedExportCountriesItem

getRestrictedExportCountries

setRestrictedExportCountries

equals

hashCode

toString