Ptsv2paymentsidcapturesOrderInformationAmountDetails (cybersource-rest-client-java 0.0.26 API)

java.lang.Object
- Model.Ptsv2paymentsidcapturesOrderInformationAmountDetails

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2020-09-14T15:19:00.879+05:30")
public class Ptsv2paymentsidcapturesOrderInformationAmountDetails
extends Object

Ptsv2paymentsidcapturesOrderInformationAmountDetails

Constructor Summary

Constructors
Constructor and Description

Ptsv2paymentsidcapturesOrderInformationAmountDetails()

Constructors
Constructor and Description
`Ptsv2paymentsidcapturesOrderInformationAmountDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`addAmexAdditionalAmountsItem(Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts amexAdditionalAmountsItem)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`addTaxDetailsItem(Ptsv2paymentsOrderInformationAmountDetailsTaxDetails taxDetailsItem)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`amexAdditionalAmounts(List<Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts> amexAdditionalAmounts)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`cashbackAmount(String cashbackAmount)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`currency(String currency)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`discountAmount(String discountAmount)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`dutyAmount(String dutyAmount)`
`boolean`	`equals(Object o)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`exchangeRate(String exchangeRate)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`exchangeRateTimeStamp(String exchangeRateTimeStamp)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`foreignAmount(String foreignAmount)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`foreignCurrency(String foreignCurrency)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`freightAmount(String freightAmount)`
`List<Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts>`	`getAmexAdditionalAmounts()` Get amexAdditionalAmounts
`String`	`getCashbackAmount()` Cashback amount in the acquirer’s currency.
`String`	`getCurrency()` Currency used for the order.
`String`	`getDiscountAmount()` Total discount amount applied to the order.
`String`	`getDutyAmount()` Total charges for any import or export duties included in the order.
`String`	`getExchangeRate()` Exchange rate returned by the DCC service.
`String`	`getExchangeRateTimeStamp()` Time stamp for the exchange rate.
`String`	`getForeignAmount()` Set this field to the converted amount that was returned by the DCC provider.
`String`	`getForeignCurrency()` Set this field to the converted amount that was returned by the DCC provider.
`String`	`getFreightAmount()` Total freight or shipping and handling charges for the order.
`String`	`getGratuityAmount()` Gratuity or tip amount for restaurants when the card is present.
`String`	`getNationalTaxIncluded()` Flag that indicates whether a national tax is included in the order total.
`String`	`getOriginalCurrency()` Your local pricing currency code.
`String`	`getServiceFeeAmount()` Service fee.
`String`	`getTaxAmount()` Total tax amount for all the items in the order.
`String`	`getTaxAppliedAfterDiscount()` Flag that indicates how the merchant manages discounts.
`String`	`getTaxAppliedLevel()` Flag that indicates how you calculate tax.
`List<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails>`	`getTaxDetails()` Get taxDetails
`String`	`getTaxTypeCode()` For tax amounts that can be categorized as one tax type.
`String`	`getTotalAmount()` Grand total for the order.
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`gratuityAmount(String gratuityAmount)`
`int`	`hashCode()`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`nationalTaxIncluded(String nationalTaxIncluded)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`originalCurrency(String originalCurrency)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`serviceFeeAmount(String serviceFeeAmount)`
`void`	`setAmexAdditionalAmounts(List<Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts> amexAdditionalAmounts)`
`void`	`setCashbackAmount(String cashbackAmount)`
`void`	`setCurrency(String currency)`
`void`	`setDiscountAmount(String discountAmount)`
`void`	`setDutyAmount(String dutyAmount)`
`void`	`setExchangeRate(String exchangeRate)`
`void`	`setExchangeRateTimeStamp(String exchangeRateTimeStamp)`
`void`	`setForeignAmount(String foreignAmount)`
`void`	`setForeignCurrency(String foreignCurrency)`
`void`	`setFreightAmount(String freightAmount)`
`void`	`setGratuityAmount(String gratuityAmount)`
`void`	`setNationalTaxIncluded(String nationalTaxIncluded)`
`void`	`setOriginalCurrency(String originalCurrency)`
`void`	`setServiceFeeAmount(String serviceFeeAmount)`
`void`	`setTaxAmount(String taxAmount)`
`void`	`setTaxAppliedAfterDiscount(String taxAppliedAfterDiscount)`
`void`	`setTaxAppliedLevel(String taxAppliedLevel)`
`void`	`setTaxDetails(List<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails> taxDetails)`
`void`	`setTaxTypeCode(String taxTypeCode)`
`void`	`setTotalAmount(String totalAmount)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`taxAmount(String taxAmount)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`taxAppliedAfterDiscount(String taxAppliedAfterDiscount)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`taxAppliedLevel(String taxAppliedLevel)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`taxDetails(List<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails> taxDetails)`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`taxTypeCode(String taxTypeCode)`
`String`	`toString()`
`Ptsv2paymentsidcapturesOrderInformationAmountDetails`	`totalAmount(String totalAmount)`

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

- Constructor Detail
  - Ptsv2paymentsidcapturesOrderInformationAmountDetails
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails()
```
- Method Detail
  - totalAmount
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails totalAmount(String totalAmount)
```
  - getTotalAmount
```
public String getTotalAmount()
```
    Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used.
    
    Returns:
    
    totalAmount
  - setTotalAmount
```
public void setTotalAmount(String totalAmount)
```
  - currency
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails currency(String currency)
```
  - getCurrency
```
public String getCurrency()
```
    Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.
    
    Returns:
    
    currency
  - setCurrency
```
public void setCurrency(String currency)
```
  - discountAmount
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails discountAmount(String discountAmount)
```
  - getDiscountAmount
```
public String getDiscountAmount()
```
    Total discount amount applied to the order.
    
    Returns:
    
    discountAmount
  - setDiscountAmount
```
public void setDiscountAmount(String discountAmount)
```
  - dutyAmount
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails dutyAmount(String dutyAmount)
```
  - getDutyAmount
```
public String getDutyAmount()
```
    Total charges for any import or export duties included in the order.
    
    Returns:
    
    dutyAmount
  - setDutyAmount
```
public void setDutyAmount(String dutyAmount)
```
  - gratuityAmount
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails gratuityAmount(String gratuityAmount)
```
  - getGratuityAmount
```
public String getGratuityAmount()
```
    Gratuity or tip amount for restaurants when the card is present. Allowed only when `industryDatatype=restaurant`. 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. #### Used by **Capture** Optional field. #### CyberSource through VisaNet Restaurant data is supported only on CyberSource through VisaNet.
    
    Returns:
    
    gratuityAmount
  - setGratuityAmount
```
public void setGratuityAmount(String gratuityAmount)
```
  - taxAmount
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails taxAmount(String taxAmount)
```
  - getTaxAmount
```
public String getTaxAmount()
```
    Total tax amount for all the items in the order.
    
    Returns:
    
    taxAmount
  - setTaxAmount
```
public void setTaxAmount(String taxAmount)
```
  - nationalTaxIncluded
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails nationalTaxIncluded(String nationalTaxIncluded)
```
  - getNationalTaxIncluded
```
public String getNationalTaxIncluded()
```
    Flag that indicates whether a national tax is included in the order total. Possible values: - **0**: national tax not included - **1**: national tax included
    
    Returns:
    
    nationalTaxIncluded
  - setNationalTaxIncluded
```
public void setNationalTaxIncluded(String nationalTaxIncluded)
```
  - taxAppliedAfterDiscount
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails taxAppliedAfterDiscount(String taxAppliedAfterDiscount)
```
  - getTaxAppliedAfterDiscount
```
public String getTaxAppliedAfterDiscount()
```
    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
    
    Returns:
    
    taxAppliedAfterDiscount
  - setTaxAppliedAfterDiscount
```
public void setTaxAppliedAfterDiscount(String taxAppliedAfterDiscount)
```
  - taxAppliedLevel
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails taxAppliedLevel(String taxAppliedLevel)
```
  - getTaxAppliedLevel
```
public String getTaxAppliedLevel()
```
    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
    
    Returns:
    
    taxAppliedLevel
  - setTaxAppliedLevel
```
public void setTaxAppliedLevel(String taxAppliedLevel)
```
  - taxTypeCode
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails taxTypeCode(String taxTypeCode)
```
  - getTaxTypeCode
```
public String getTaxTypeCode()
```
    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.
    
    Returns:
    
    taxTypeCode
  - setTaxTypeCode
```
public void setTaxTypeCode(String taxTypeCode)
```
  - freightAmount
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails freightAmount(String freightAmount)
```
  - getFreightAmount
```
public String getFreightAmount()
```
    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.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
    
    Returns:
    
    freightAmount
  - setFreightAmount
```
public void setFreightAmount(String freightAmount)
```
  - foreignAmount
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails foreignAmount(String foreignAmount)
```
  - getForeignAmount
```
public String getForeignAmount()
```
    Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` 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/)
    
    Returns:
    
    foreignAmount
  - setForeignAmount
```
public void setForeignAmount(String foreignAmount)
```
  - foreignCurrency
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails foreignCurrency(String foreignCurrency)
```
  - getForeignCurrency
```
public String getForeignCurrency()
```
    Set this field to the converted amount that was returned by the DCC provider.
    
    Returns:
    
    foreignCurrency
  - setForeignCurrency
```
public void setForeignCurrency(String foreignCurrency)
```
  - exchangeRate
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails exchangeRate(String exchangeRate)
```
  - getExchangeRate
```
public String getExchangeRate()
```
    Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf)
    
    Returns:
    
    exchangeRate
  - setExchangeRate
```
public void setExchangeRate(String exchangeRate)
```
  - exchangeRateTimeStamp
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails exchangeRateTimeStamp(String exchangeRateTimeStamp)
```
  - getExchangeRateTimeStamp
```
public String getExchangeRateTimeStamp()
```
    Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space.
    
    Returns:
    
    exchangeRateTimeStamp
  - setExchangeRateTimeStamp
```
public void setExchangeRateTimeStamp(String exchangeRateTimeStamp)
```
  - amexAdditionalAmounts
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails amexAdditionalAmounts(List<Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts> amexAdditionalAmounts)
```
  - addAmexAdditionalAmountsItem
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails addAmexAdditionalAmountsItem(Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts amexAdditionalAmountsItem)
```
  - getAmexAdditionalAmounts
```
public List<Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts> getAmexAdditionalAmounts()
```
    Get amexAdditionalAmounts
    
    Returns:
    
    amexAdditionalAmounts
  - setAmexAdditionalAmounts
```
public void setAmexAdditionalAmounts(List<Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts> amexAdditionalAmounts)
```
  - taxDetails
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails taxDetails(List<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails> taxDetails)
```
  - addTaxDetailsItem
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails addTaxDetailsItem(Ptsv2paymentsOrderInformationAmountDetailsTaxDetails taxDetailsItem)
```
  - getTaxDetails
```
public List<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails> getTaxDetails()
```
    Get taxDetails
    
    Returns:
    
    taxDetails
  - setTaxDetails
```
public void setTaxDetails(List<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails> taxDetails)
```
  - serviceFeeAmount
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails serviceFeeAmount(String serviceFeeAmount)
```
  - getServiceFeeAmount
```
public String getServiceFeeAmount()
```
    Service fee. Required for service fee transactions.
    
    Returns:
    
    serviceFeeAmount
  - setServiceFeeAmount
```
public void setServiceFeeAmount(String serviceFeeAmount)
```
  - originalCurrency
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails originalCurrency(String originalCurrency)
```
  - getOriginalCurrency
```
public String getOriginalCurrency()
```
    Your local pricing currency code. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
    
    Returns:
    
    originalCurrency
  - setOriginalCurrency
```
public void setOriginalCurrency(String originalCurrency)
```
  - cashbackAmount
```
public Ptsv2paymentsidcapturesOrderInformationAmountDetails cashbackAmount(String cashbackAmount)
```
  - getCashbackAmount
```
public String getCashbackAmount()
```
    Cashback amount in the acquirer’s currency. If a cashback amount is included in the request, it must be included in the `orderInformation.amountDetails.totalAmount` value. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization** Optional. **Authorization Reversal** Optional. #### PIN debit Required field for PIN debit purchase, PIN debit credit or PIN debit reversal.
    
    Returns:
    
    cashbackAmount
  - setCashbackAmount
```
public void setCashbackAmount(String cashbackAmount)
```
  - 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 Ptsv2paymentsidcapturesOrderInformationAmountDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Ptsv2paymentsidcapturesOrderInformationAmountDetails

Method Detail

totalAmount

getTotalAmount

setTotalAmount

currency

getCurrency

setCurrency

discountAmount

getDiscountAmount

setDiscountAmount

dutyAmount

getDutyAmount

setDutyAmount

gratuityAmount

getGratuityAmount

setGratuityAmount

taxAmount

getTaxAmount

setTaxAmount

nationalTaxIncluded

getNationalTaxIncluded

setNationalTaxIncluded

taxAppliedAfterDiscount

getTaxAppliedAfterDiscount

setTaxAppliedAfterDiscount

taxAppliedLevel

getTaxAppliedLevel

setTaxAppliedLevel

taxTypeCode

getTaxTypeCode

setTaxTypeCode

freightAmount

getFreightAmount

setFreightAmount

foreignAmount

getForeignAmount

setForeignAmount

foreignCurrency

getForeignCurrency

setForeignCurrency

exchangeRate

getExchangeRate

setExchangeRate

exchangeRateTimeStamp

getExchangeRateTimeStamp

setExchangeRateTimeStamp

amexAdditionalAmounts

addAmexAdditionalAmountsItem

getAmexAdditionalAmounts

setAmexAdditionalAmounts

taxDetails

addTaxDetailsItem

getTaxDetails

setTaxDetails

serviceFeeAmount

getServiceFeeAmount

setServiceFeeAmount

originalCurrency

getOriginalCurrency

setOriginalCurrency

cashbackAmount

getCashbackAmount

setCashbackAmount

equals

hashCode

toString