Model.Ptsv2paymentsOrderInformationAmountDetails Maven / Gradle / Ivy
/*
* CyberSource Merged Spec
* All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
*
* OpenAPI spec version: 0.0.1
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
package Model;
import java.util.Objects;
import java.util.Arrays;
import Model.Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts;
import Model.Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion;
import Model.Ptsv2paymentsOrderInformationAmountDetailsOctsurcharge;
import Model.Ptsv2paymentsOrderInformationAmountDetailsOrder;
import Model.Ptsv2paymentsOrderInformationAmountDetailsSurcharge;
import Model.Ptsv2paymentsOrderInformationAmountDetailsTaxDetails;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
/**
* Ptsv2paymentsOrderInformationAmountDetails
*/
public class Ptsv2paymentsOrderInformationAmountDetails {
@SerializedName("giftWrapAmount")
private String giftWrapAmount = null;
@SerializedName("totalAmount")
private String totalAmount = null;
@SerializedName("subTotalAmount")
private String subTotalAmount = null;
@SerializedName("currency")
private String currency = null;
@SerializedName("discountAmount")
private String discountAmount = null;
@SerializedName("dutyAmount")
private String dutyAmount = null;
@SerializedName("gratuityAmount")
private String gratuityAmount = null;
@SerializedName("taxAmount")
private String taxAmount = null;
@SerializedName("nationalTaxIncluded")
private String nationalTaxIncluded = null;
@SerializedName("taxAppliedAfterDiscount")
private String taxAppliedAfterDiscount = null;
@SerializedName("taxAppliedLevel")
private String taxAppliedLevel = null;
@SerializedName("taxTypeCode")
private String taxTypeCode = null;
@SerializedName("freightAmount")
private String freightAmount = null;
@SerializedName("foreignAmount")
private String foreignAmount = null;
@SerializedName("foreignCurrency")
private String foreignCurrency = null;
@SerializedName("exchangeRate")
private String exchangeRate = null;
@SerializedName("exchangeRateTimeStamp")
private String exchangeRateTimeStamp = null;
@SerializedName("surcharge")
private Ptsv2paymentsOrderInformationAmountDetailsSurcharge surcharge = null;
@SerializedName("settlementAmount")
private String settlementAmount = null;
@SerializedName("settlementCurrency")
private String settlementCurrency = null;
@SerializedName("amexAdditionalAmounts")
private List amexAdditionalAmounts = null;
@SerializedName("taxDetails")
private List taxDetails = null;
@SerializedName("serviceFeeAmount")
private String serviceFeeAmount = null;
@SerializedName("originalAmount")
private String originalAmount = null;
@SerializedName("originalCurrency")
private String originalCurrency = null;
@SerializedName("cashbackAmount")
private String cashbackAmount = null;
@SerializedName("currencyConversion")
private Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion currencyConversion = null;
@SerializedName("oct-surcharge")
private Ptsv2paymentsOrderInformationAmountDetailsOctsurcharge octSurcharge = null;
@SerializedName("order")
private Ptsv2paymentsOrderInformationAmountDetailsOrder order = null;
@SerializedName("anticipatedAmount")
private String anticipatedAmount = null;
public Ptsv2paymentsOrderInformationAmountDetails giftWrapAmount(String giftWrapAmount) {
this.giftWrapAmount = giftWrapAmount;
return this;
}
/**
* Amount being charged as gift wrap fee.
* @return giftWrapAmount
**/
@ApiModelProperty(value = "Amount being charged as gift wrap fee. ")
public String getGiftWrapAmount() {
return giftWrapAmount;
}
public void setGiftWrapAmount(String giftWrapAmount) {
this.giftWrapAmount = giftWrapAmount;
}
public Ptsv2paymentsOrderInformationAmountDetails totalAmount(String totalAmount) {
this.totalAmount = totalAmount;
return this;
}
/**
* 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. 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. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing / Pay By Link Required for creating a new invoice or payment link. #### 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. #### DCC for First Data Not used.
* @return totalAmount
**/
@ApiModelProperty(value = "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. 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. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing / Pay By Link Required for creating a new invoice or payment link. #### 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. #### DCC for First Data Not used. ")
public String getTotalAmount() {
return totalAmount;
}
public void setTotalAmount(String totalAmount) {
this.totalAmount = totalAmount;
}
public Ptsv2paymentsOrderInformationAmountDetails subTotalAmount(String subTotalAmount) {
this.subTotalAmount = subTotalAmount;
return this;
}
/**
* Subtotal amount of all the items.This amount (which is the value of all items in the cart, not including the additional amounts such as tax, shipping, etc.) cannot change after a sessions request. When there is a change to any of the additional amounts, this field should be resent in the order request. When the sub total amount changes, you must initiate a new transaction starting with a sessions request. Note The amount value must be a non-negative number containing 2 decimal places and limited to 7 digits before the decimal point. This value can not be changed after a sessions request.
* @return subTotalAmount
**/
@ApiModelProperty(value = "Subtotal amount of all the items.This amount (which is the value of all items in the cart, not including the additional amounts such as tax, shipping, etc.) cannot change after a sessions request. When there is a change to any of the additional amounts, this field should be resent in the order request. When the sub total amount changes, you must initiate a new transaction starting with a sessions request. Note The amount value must be a non-negative number containing 2 decimal places and limited to 7 digits before the decimal point. This value can not be changed after a sessions request. ")
public String getSubTotalAmount() {
return subTotalAmount;
}
public void setSubTotalAmount(String subTotalAmount) {
this.subTotalAmount = subTotalAmount;
}
public Ptsv2paymentsOrderInformationAmountDetails currency(String currency) {
this.currency = currency;
return this;
}
/**
* 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. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.
* @return currency
**/
@ApiModelProperty(value = "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. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. ")
public String getCurrency() {
return currency;
}
public void setCurrency(String currency) {
this.currency = currency;
}
public Ptsv2paymentsOrderInformationAmountDetails discountAmount(String discountAmount) {
this.discountAmount = discountAmount;
return this;
}
/**
* Total discount amount applied to the order.
* @return discountAmount
**/
@ApiModelProperty(value = "Total discount amount applied to the order. ")
public String getDiscountAmount() {
return discountAmount;
}
public void setDiscountAmount(String discountAmount) {
this.discountAmount = discountAmount;
}
public Ptsv2paymentsOrderInformationAmountDetails dutyAmount(String dutyAmount) {
this.dutyAmount = dutyAmount;
return this;
}
/**
* Total charges for any import or export duties included in the order.
* @return dutyAmount
**/
@ApiModelProperty(value = "Total charges for any import or export duties included in the order. ")
public String getDutyAmount() {
return dutyAmount;
}
public void setDutyAmount(String dutyAmount) {
this.dutyAmount = dutyAmount;
}
public Ptsv2paymentsOrderInformationAmountDetails gratuityAmount(String gratuityAmount) {
this.gratuityAmount = gratuityAmount;
return this;
}
/**
* Gratuity or tip amount for restaurants. 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 when card is present.
* @return gratuityAmount
**/
@ApiModelProperty(value = "Gratuity or tip amount for restaurants. 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 when card is present. ")
public String getGratuityAmount() {
return gratuityAmount;
}
public void setGratuityAmount(String gratuityAmount) {
this.gratuityAmount = gratuityAmount;
}
public Ptsv2paymentsOrderInformationAmountDetails taxAmount(String taxAmount) {
this.taxAmount = taxAmount;
return this;
}
/**
* Total tax amount for all the items in the order.
* @return taxAmount
**/
@ApiModelProperty(value = "Total tax amount for all the items in the order. ")
public String getTaxAmount() {
return taxAmount;
}
public void setTaxAmount(String taxAmount) {
this.taxAmount = taxAmount;
}
public Ptsv2paymentsOrderInformationAmountDetails nationalTaxIncluded(String nationalTaxIncluded) {
this.nationalTaxIncluded = nationalTaxIncluded;
return this;
}
/**
* Flag that indicates whether a national tax is included in the order total. Possible values: - **0**: national tax not included - **1**: national tax included
* @return nationalTaxIncluded
**/
@ApiModelProperty(value = "Flag that indicates whether a national tax is included in the order total. Possible values: - **0**: national tax not included - **1**: national tax included ")
public String getNationalTaxIncluded() {
return nationalTaxIncluded;
}
public void setNationalTaxIncluded(String nationalTaxIncluded) {
this.nationalTaxIncluded = nationalTaxIncluded;
}
public Ptsv2paymentsOrderInformationAmountDetails taxAppliedAfterDiscount(String taxAppliedAfterDiscount) {
this.taxAppliedAfterDiscount = taxAppliedAfterDiscount;
return this;
}
/**
* 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
* @return taxAppliedAfterDiscount
**/
@ApiModelProperty(value = "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 ")
public String getTaxAppliedAfterDiscount() {
return taxAppliedAfterDiscount;
}
public void setTaxAppliedAfterDiscount(String taxAppliedAfterDiscount) {
this.taxAppliedAfterDiscount = taxAppliedAfterDiscount;
}
public Ptsv2paymentsOrderInformationAmountDetails taxAppliedLevel(String taxAppliedLevel) {
this.taxAppliedLevel = taxAppliedLevel;
return this;
}
/**
* 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
* @return taxAppliedLevel
**/
@ApiModelProperty(value = "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 ")
public String getTaxAppliedLevel() {
return taxAppliedLevel;
}
public void setTaxAppliedLevel(String taxAppliedLevel) {
this.taxAppliedLevel = taxAppliedLevel;
}
public Ptsv2paymentsOrderInformationAmountDetails taxTypeCode(String taxTypeCode) {
this.taxTypeCode = taxTypeCode;
return this;
}
/**
* 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.
* @return taxTypeCode
**/
@ApiModelProperty(value = "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. ")
public String getTaxTypeCode() {
return taxTypeCode;
}
public void setTaxTypeCode(String taxTypeCode) {
this.taxTypeCode = taxTypeCode;
}
public Ptsv2paymentsOrderInformationAmountDetails freightAmount(String freightAmount) {
this.freightAmount = freightAmount;
return this;
}
/**
* 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.
* @return freightAmount
**/
@ApiModelProperty(value = "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. ")
public String getFreightAmount() {
return freightAmount;
}
public void setFreightAmount(String freightAmount) {
this.freightAmount = freightAmount;
}
public Ptsv2paymentsOrderInformationAmountDetails foreignAmount(String foreignAmount) {
this.foreignAmount = foreignAmount;
return this;
}
/**
* Set this field to the converted amount that was returned by the DCC provider.
* @return foreignAmount
**/
@ApiModelProperty(value = "Set this field to the converted amount that was returned by the DCC provider. ")
public String getForeignAmount() {
return foreignAmount;
}
public void setForeignAmount(String foreignAmount) {
this.foreignAmount = foreignAmount;
}
public Ptsv2paymentsOrderInformationAmountDetails foreignCurrency(String foreignCurrency) {
this.foreignCurrency = foreignCurrency;
return this;
}
/**
* Set this field to the converted amount that was returned by the DCC provider.
* @return foreignCurrency
**/
@ApiModelProperty(value = "Set this field to the converted amount that was returned by the DCC provider. ")
public String getForeignCurrency() {
return foreignCurrency;
}
public void setForeignCurrency(String foreignCurrency) {
this.foreignCurrency = foreignCurrency;
}
public Ptsv2paymentsOrderInformationAmountDetails exchangeRate(String exchangeRate) {
this.exchangeRate = exchangeRate;
return this;
}
/**
* Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.
* @return exchangeRate
**/
@ApiModelProperty(value = "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. ")
public String getExchangeRate() {
return exchangeRate;
}
public void setExchangeRate(String exchangeRate) {
this.exchangeRate = exchangeRate;
}
public Ptsv2paymentsOrderInformationAmountDetails exchangeRateTimeStamp(String exchangeRateTimeStamp) {
this.exchangeRateTimeStamp = exchangeRateTimeStamp;
return this;
}
/**
* Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space.
* @return exchangeRateTimeStamp
**/
@ApiModelProperty(value = "Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space. ")
public String getExchangeRateTimeStamp() {
return exchangeRateTimeStamp;
}
public void setExchangeRateTimeStamp(String exchangeRateTimeStamp) {
this.exchangeRateTimeStamp = exchangeRateTimeStamp;
}
public Ptsv2paymentsOrderInformationAmountDetails surcharge(Ptsv2paymentsOrderInformationAmountDetailsSurcharge surcharge) {
this.surcharge = surcharge;
return this;
}
/**
* Get surcharge
* @return surcharge
**/
@ApiModelProperty(value = "")
public Ptsv2paymentsOrderInformationAmountDetailsSurcharge getSurcharge() {
return surcharge;
}
public void setSurcharge(Ptsv2paymentsOrderInformationAmountDetailsSurcharge surcharge) {
this.surcharge = surcharge;
}
public Ptsv2paymentsOrderInformationAmountDetails settlementAmount(String settlementAmount) {
this.settlementAmount = settlementAmount;
return this;
}
/**
* This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions.
* @return settlementAmount
**/
@ApiModelProperty(value = "This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions. ")
public String getSettlementAmount() {
return settlementAmount;
}
public void setSettlementAmount(String settlementAmount) {
this.settlementAmount = settlementAmount;
}
public Ptsv2paymentsOrderInformationAmountDetails settlementCurrency(String settlementCurrency) {
this.settlementCurrency = settlementCurrency;
return this;
}
/**
* 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. This field is returned for OCT transactions.
* @return settlementCurrency
**/
@ApiModelProperty(value = "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. This field is returned for OCT transactions. ")
public String getSettlementCurrency() {
return settlementCurrency;
}
public void setSettlementCurrency(String settlementCurrency) {
this.settlementCurrency = settlementCurrency;
}
public Ptsv2paymentsOrderInformationAmountDetails amexAdditionalAmounts(List amexAdditionalAmounts) {
this.amexAdditionalAmounts = amexAdditionalAmounts;
return this;
}
public Ptsv2paymentsOrderInformationAmountDetails addAmexAdditionalAmountsItem(Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts amexAdditionalAmountsItem) {
if (this.amexAdditionalAmounts == null) {
this.amexAdditionalAmounts = new ArrayList();
}
this.amexAdditionalAmounts.add(amexAdditionalAmountsItem);
return this;
}
/**
* Get amexAdditionalAmounts
* @return amexAdditionalAmounts
**/
@ApiModelProperty(value = "")
public List getAmexAdditionalAmounts() {
return amexAdditionalAmounts;
}
public void setAmexAdditionalAmounts(List amexAdditionalAmounts) {
this.amexAdditionalAmounts = amexAdditionalAmounts;
}
public Ptsv2paymentsOrderInformationAmountDetails taxDetails(List taxDetails) {
this.taxDetails = taxDetails;
return this;
}
public Ptsv2paymentsOrderInformationAmountDetails addTaxDetailsItem(Ptsv2paymentsOrderInformationAmountDetailsTaxDetails taxDetailsItem) {
if (this.taxDetails == null) {
this.taxDetails = new ArrayList();
}
this.taxDetails.add(taxDetailsItem);
return this;
}
/**
* Get taxDetails
* @return taxDetails
**/
@ApiModelProperty(value = "")
public List getTaxDetails() {
return taxDetails;
}
public void setTaxDetails(List taxDetails) {
this.taxDetails = taxDetails;
}
public Ptsv2paymentsOrderInformationAmountDetails serviceFeeAmount(String serviceFeeAmount) {
this.serviceFeeAmount = serviceFeeAmount;
return this;
}
/**
* Service fee. Required for service fee transactions.
* @return serviceFeeAmount
**/
@ApiModelProperty(value = "Service fee. Required for service fee transactions. ")
public String getServiceFeeAmount() {
return serviceFeeAmount;
}
public void setServiceFeeAmount(String serviceFeeAmount) {
this.serviceFeeAmount = serviceFeeAmount;
}
public Ptsv2paymentsOrderInformationAmountDetails originalAmount(String originalAmount) {
this.originalAmount = originalAmount;
return this;
}
/**
* Amount in your original local pricing currency. 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, CyberSource truncates the amount to the correct number of decimal places.
* @return originalAmount
**/
@ApiModelProperty(value = "Amount in your original local pricing currency. 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, CyberSource truncates the amount to the correct number of decimal places. ")
public String getOriginalAmount() {
return originalAmount;
}
public void setOriginalAmount(String originalAmount) {
this.originalAmount = originalAmount;
}
public Ptsv2paymentsOrderInformationAmountDetails originalCurrency(String originalCurrency) {
this.originalCurrency = originalCurrency;
return this;
}
/**
* 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)
* @return originalCurrency
**/
@ApiModelProperty(value = "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) ")
public String getOriginalCurrency() {
return originalCurrency;
}
public void setOriginalCurrency(String originalCurrency) {
this.originalCurrency = originalCurrency;
}
public Ptsv2paymentsOrderInformationAmountDetails cashbackAmount(String cashbackAmount) {
this.cashbackAmount = cashbackAmount;
return this;
}
/**
* 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 Optional field for PIN debit purchase, PIN debit credit or PIN debit reversal.
* @return cashbackAmount
**/
@ApiModelProperty(value = "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 Optional field for PIN debit purchase, PIN debit credit or PIN debit reversal. ")
public String getCashbackAmount() {
return cashbackAmount;
}
public void setCashbackAmount(String cashbackAmount) {
this.cashbackAmount = cashbackAmount;
}
public Ptsv2paymentsOrderInformationAmountDetails currencyConversion(Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion currencyConversion) {
this.currencyConversion = currencyConversion;
return this;
}
/**
* Get currencyConversion
* @return currencyConversion
**/
@ApiModelProperty(value = "")
public Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion getCurrencyConversion() {
return currencyConversion;
}
public void setCurrencyConversion(Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion currencyConversion) {
this.currencyConversion = currencyConversion;
}
public Ptsv2paymentsOrderInformationAmountDetails octSurcharge(Ptsv2paymentsOrderInformationAmountDetailsOctsurcharge octSurcharge) {
this.octSurcharge = octSurcharge;
return this;
}
/**
* Get octSurcharge
* @return octSurcharge
**/
@ApiModelProperty(value = "")
public Ptsv2paymentsOrderInformationAmountDetailsOctsurcharge getOctSurcharge() {
return octSurcharge;
}
public void setOctSurcharge(Ptsv2paymentsOrderInformationAmountDetailsOctsurcharge octSurcharge) {
this.octSurcharge = octSurcharge;
}
public Ptsv2paymentsOrderInformationAmountDetails order(Ptsv2paymentsOrderInformationAmountDetailsOrder order) {
this.order = order;
return this;
}
/**
* Get order
* @return order
**/
@ApiModelProperty(value = "")
public Ptsv2paymentsOrderInformationAmountDetailsOrder getOrder() {
return order;
}
public void setOrder(Ptsv2paymentsOrderInformationAmountDetailsOrder order) {
this.order = order;
}
public Ptsv2paymentsOrderInformationAmountDetails anticipatedAmount(String anticipatedAmount) {
this.anticipatedAmount = anticipatedAmount;
return this;
}
/**
* This API Field contains the anticipated amount details. This supports use cases where the Merchant does not wish to have funds held against the account, but needs to confirm an amount prior to authorization, such as for a trial subscription, reservation service, or loyalty program. In an account verification, the anticipated amount is used to confirm the account has availability to accept purchases.
* @return anticipatedAmount
**/
@ApiModelProperty(value = "This API Field contains the anticipated amount details. This supports use cases where the Merchant does not wish to have funds held against the account, but needs to confirm an amount prior to authorization, such as for a trial subscription, reservation service, or loyalty program. In an account verification, the anticipated amount is used to confirm the account has availability to accept purchases. ")
public String getAnticipatedAmount() {
return anticipatedAmount;
}
public void setAnticipatedAmount(String anticipatedAmount) {
this.anticipatedAmount = anticipatedAmount;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Ptsv2paymentsOrderInformationAmountDetails ptsv2paymentsOrderInformationAmountDetails = (Ptsv2paymentsOrderInformationAmountDetails) o;
return Objects.equals(this.giftWrapAmount, ptsv2paymentsOrderInformationAmountDetails.giftWrapAmount) &&
Objects.equals(this.totalAmount, ptsv2paymentsOrderInformationAmountDetails.totalAmount) &&
Objects.equals(this.subTotalAmount, ptsv2paymentsOrderInformationAmountDetails.subTotalAmount) &&
Objects.equals(this.currency, ptsv2paymentsOrderInformationAmountDetails.currency) &&
Objects.equals(this.discountAmount, ptsv2paymentsOrderInformationAmountDetails.discountAmount) &&
Objects.equals(this.dutyAmount, ptsv2paymentsOrderInformationAmountDetails.dutyAmount) &&
Objects.equals(this.gratuityAmount, ptsv2paymentsOrderInformationAmountDetails.gratuityAmount) &&
Objects.equals(this.taxAmount, ptsv2paymentsOrderInformationAmountDetails.taxAmount) &&
Objects.equals(this.nationalTaxIncluded, ptsv2paymentsOrderInformationAmountDetails.nationalTaxIncluded) &&
Objects.equals(this.taxAppliedAfterDiscount, ptsv2paymentsOrderInformationAmountDetails.taxAppliedAfterDiscount) &&
Objects.equals(this.taxAppliedLevel, ptsv2paymentsOrderInformationAmountDetails.taxAppliedLevel) &&
Objects.equals(this.taxTypeCode, ptsv2paymentsOrderInformationAmountDetails.taxTypeCode) &&
Objects.equals(this.freightAmount, ptsv2paymentsOrderInformationAmountDetails.freightAmount) &&
Objects.equals(this.foreignAmount, ptsv2paymentsOrderInformationAmountDetails.foreignAmount) &&
Objects.equals(this.foreignCurrency, ptsv2paymentsOrderInformationAmountDetails.foreignCurrency) &&
Objects.equals(this.exchangeRate, ptsv2paymentsOrderInformationAmountDetails.exchangeRate) &&
Objects.equals(this.exchangeRateTimeStamp, ptsv2paymentsOrderInformationAmountDetails.exchangeRateTimeStamp) &&
Objects.equals(this.surcharge, ptsv2paymentsOrderInformationAmountDetails.surcharge) &&
Objects.equals(this.settlementAmount, ptsv2paymentsOrderInformationAmountDetails.settlementAmount) &&
Objects.equals(this.settlementCurrency, ptsv2paymentsOrderInformationAmountDetails.settlementCurrency) &&
Objects.equals(this.amexAdditionalAmounts, ptsv2paymentsOrderInformationAmountDetails.amexAdditionalAmounts) &&
Objects.equals(this.taxDetails, ptsv2paymentsOrderInformationAmountDetails.taxDetails) &&
Objects.equals(this.serviceFeeAmount, ptsv2paymentsOrderInformationAmountDetails.serviceFeeAmount) &&
Objects.equals(this.originalAmount, ptsv2paymentsOrderInformationAmountDetails.originalAmount) &&
Objects.equals(this.originalCurrency, ptsv2paymentsOrderInformationAmountDetails.originalCurrency) &&
Objects.equals(this.cashbackAmount, ptsv2paymentsOrderInformationAmountDetails.cashbackAmount) &&
Objects.equals(this.currencyConversion, ptsv2paymentsOrderInformationAmountDetails.currencyConversion) &&
Objects.equals(this.octSurcharge, ptsv2paymentsOrderInformationAmountDetails.octSurcharge) &&
Objects.equals(this.order, ptsv2paymentsOrderInformationAmountDetails.order) &&
Objects.equals(this.anticipatedAmount, ptsv2paymentsOrderInformationAmountDetails.anticipatedAmount);
}
@Override
public int hashCode() {
return Objects.hash(giftWrapAmount, totalAmount, subTotalAmount, currency, discountAmount, dutyAmount, gratuityAmount, taxAmount, nationalTaxIncluded, taxAppliedAfterDiscount, taxAppliedLevel, taxTypeCode, freightAmount, foreignAmount, foreignCurrency, exchangeRate, exchangeRateTimeStamp, surcharge, settlementAmount, settlementCurrency, amexAdditionalAmounts, taxDetails, serviceFeeAmount, originalAmount, originalCurrency, cashbackAmount, currencyConversion, octSurcharge, order, anticipatedAmount);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Ptsv2paymentsOrderInformationAmountDetails {\n");
if (giftWrapAmount != null) sb.append(" giftWrapAmount: ").append(toIndentedString(giftWrapAmount)).append("\n");
if (totalAmount != null) sb.append(" totalAmount: ").append(toIndentedString(totalAmount)).append("\n");
if (subTotalAmount != null) sb.append(" subTotalAmount: ").append(toIndentedString(subTotalAmount)).append("\n");
if (currency != null) sb.append(" currency: ").append(toIndentedString(currency)).append("\n");
if (discountAmount != null) sb.append(" discountAmount: ").append(toIndentedString(discountAmount)).append("\n");
if (dutyAmount != null) sb.append(" dutyAmount: ").append(toIndentedString(dutyAmount)).append("\n");
if (gratuityAmount != null) sb.append(" gratuityAmount: ").append(toIndentedString(gratuityAmount)).append("\n");
if (taxAmount != null) sb.append(" taxAmount: ").append(toIndentedString(taxAmount)).append("\n");
if (nationalTaxIncluded != null) sb.append(" nationalTaxIncluded: ").append(toIndentedString(nationalTaxIncluded)).append("\n");
if (taxAppliedAfterDiscount != null) sb.append(" taxAppliedAfterDiscount: ").append(toIndentedString(taxAppliedAfterDiscount)).append("\n");
if (taxAppliedLevel != null) sb.append(" taxAppliedLevel: ").append(toIndentedString(taxAppliedLevel)).append("\n");
if (taxTypeCode != null) sb.append(" taxTypeCode: ").append(toIndentedString(taxTypeCode)).append("\n");
if (freightAmount != null) sb.append(" freightAmount: ").append(toIndentedString(freightAmount)).append("\n");
if (foreignAmount != null) sb.append(" foreignAmount: ").append(toIndentedString(foreignAmount)).append("\n");
if (foreignCurrency != null) sb.append(" foreignCurrency: ").append(toIndentedString(foreignCurrency)).append("\n");
if (exchangeRate != null) sb.append(" exchangeRate: ").append(toIndentedString(exchangeRate)).append("\n");
if (exchangeRateTimeStamp != null) sb.append(" exchangeRateTimeStamp: ").append(toIndentedString(exchangeRateTimeStamp)).append("\n");
if (surcharge != null) sb.append(" surcharge: ").append(toIndentedString(surcharge)).append("\n");
if (settlementAmount != null) sb.append(" settlementAmount: ").append(toIndentedString(settlementAmount)).append("\n");
if (settlementCurrency != null) sb.append(" settlementCurrency: ").append(toIndentedString(settlementCurrency)).append("\n");
if (amexAdditionalAmounts != null) sb.append(" amexAdditionalAmounts: ").append(toIndentedString(amexAdditionalAmounts)).append("\n");
if (taxDetails != null) sb.append(" taxDetails: ").append(toIndentedString(taxDetails)).append("\n");
if (serviceFeeAmount != null) sb.append(" serviceFeeAmount: ").append(toIndentedString(serviceFeeAmount)).append("\n");
if (originalAmount != null) sb.append(" originalAmount: ").append(toIndentedString(originalAmount)).append("\n");
if (originalCurrency != null) sb.append(" originalCurrency: ").append(toIndentedString(originalCurrency)).append("\n");
if (cashbackAmount != null) sb.append(" cashbackAmount: ").append(toIndentedString(cashbackAmount)).append("\n");
if (currencyConversion != null) sb.append(" currencyConversion: ").append(toIndentedString(currencyConversion)).append("\n");
if (octSurcharge != null) sb.append(" octSurcharge: ").append(toIndentedString(octSurcharge)).append("\n");
if (order != null) sb.append(" order: ").append(toIndentedString(order)).append("\n");
if (anticipatedAmount != null) sb.append(" anticipatedAmount: ").append(toIndentedString(anticipatedAmount)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
// return "null";
}
return o.toString().replace("\n", "\n ");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy