com.adyen.model.nexo.TransactionTotals Maven / Gradle / Ivy
package com.adyen.model.nexo;
import io.swagger.v3.oas.annotations.media.Schema;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
import java.util.ArrayList;
import java.util.List;
/**
* Definition: Result of the Sale to POI Reconciliation processing. -- Usage: If Result is Success, contains all the totals, classified as required by the Sale in the messageType request. At least, transaction totals are provided per Acquirer, Acquirer Settlement, and Card Brand.
*
* Java class for TransactionTotals complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="TransactionTotals">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="PaymentTotals" type="{}PaymentTotals" maxOccurs="10" minOccurs="0"/>
* <element name="LoyaltyTotals" type="{}LoyaltyTotals" maxOccurs="6" minOccurs="0"/>
* </sequence>
* <attribute name="PaymentInstrument" use="required" type="{}PaymentInstrumentType" />
* <attribute name="AcquirerID" type="{}AcquirerID" />
* <attribute name="ErrorCondition" type="{}ErrorConditionType" />
* <attribute name="HostReconciliationID" type="{}HostReconciliationID" />
* <attribute name="CardBrand" type="{}CardBrand" />
* <attribute name="POIID" type="{}POIID" />
* <attribute name="SaleID" type="{}SaleID" />
* <attribute name="OperatorID" type="{}OperatorID" />
* <attribute name="ShiftNumber" type="{}ShiftNumber" />
* <attribute name="TotalsGroupID" type="{}TotalsGroupID" />
* <attribute name="PaymentCurrency" type="{}ISOCurrency3A" />
* <attribute name="LoyaltyUnit" type="{}LoyaltyUnitType" default="Point" />
* <attribute name="LoyaltyCurrency" type="{}ISOCurrency3A" />
* </restriction>
* </complexContent>
* </complexType>
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "TransactionTotals", propOrder = {
"paymentTotals",
"loyaltyTotals"
})
public class TransactionTotals {
/**
* The Payment totals.
*/
@XmlElement(name = "PaymentTotals")
@Schema(description = "Totals of the payment transaction during the reconciliation period. --Rule: If both TransactionCount and TransactionAmount are not equal to zero")
protected List paymentTotals;
/**
* The Loyalty totals.
*/
@XmlElement(name = "LoyaltyTotals")
@Schema(description = "Totals of the loyalty transaction during the reconciliation period. --Rule: If both TransactionCount and TransactionAmount are not equal to zero")
protected List loyaltyTotals;
/**
* The Payment instrument.
*/
@XmlElement(name = "PaymentInstrumentType", required = true)
@Schema(description = "Type of payment instrument.")
protected PaymentInstrumentType paymentInstrumentType;
/**
* The Acquirer id.
*/
@XmlElement(name = "AcquirerID")
@Schema(description = "Identification of the Acquirer --Rule: If available")
protected String acquirerID;
/**
* The Error condition.
*/
@XmlElement(name = "ErrorCondition")
@Schema(description = "Condition that has produced an error on the processing of a message request --Rule: if Response.Result is Partial, and the reconciliation with this Acquirer failed.")
protected ErrorConditionType errorCondition;
/**
* The Host reconciliation id.
*/
@XmlElement(name = "HostReconciliationID")
@Schema(description = "Identifier of a reconciliation period with a payment or loyalty host. --Rule: If available")
protected String hostReconciliationID;
/**
* The Card brand.
*/
@XmlElement(name = "CardBrand")
@Schema(description = "Type of payment or loyalty card --Rule: If configured to present totals per card brand, and Response.Result is Success")
protected String cardBrand;
/**
* The Poiid.
*/
@XmlElement(name = "POIID")
@Schema(description = "Identification of a POI System or a POI Terminal for the Sale to POI protocol --Rule: If requested in the message request")
protected String poiid;
/**
* The Sale id.
*/
@XmlElement(name = "SaleID")
@Schema(description = "Identification of a Sale System or a Sale Terminal for the Sale to POI protocol --Rule: If requested in the message request")
protected String saleID;
/**
* The Operator id.
*/
@XmlElement(name = "OperatorID")
@Schema(description = "Identification of the Cashier or Operator. --Rule: If requested in the message request")
protected String operatorID;
/**
* The Shift number.
*/
@XmlElement(name = "ShiftNumber")
@Schema(description = "Shift number. --Rule: If requested in the message request")
protected String shiftNumber;
/**
* The Totals group id.
*/
@XmlElement(name = "TotalsGroupID")
@Schema(description = "Identification of a group of transaction on a POI Terminal, having the same Sale features. --Rule: If requested in the message request")
protected String totalsGroupID;
/**
* The Payment currency.
*/
@XmlElement(name = "PaymentCurrency")
@Schema(description = "Currency of a monetary amount.")
protected String paymentCurrency;
/**
* The Loyalty unit.
*/
@XmlElement(name = "LoyaltyUnit")
@Schema(description = "Unit of a loyalty amount.")
protected LoyaltyUnitType loyaltyUnit;
/**
* The Loyalty currency.
*/
@XmlElement(name = "LoyaltyCurrency")
@Schema(description = "Currency of a monetary amount. --Rule: If LoyaltyUnit is Monetary")
protected String loyaltyCurrency;
/**
* Gets the value of the paymentTotals property.
*
*
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
* This is why there is not a set method for the paymentTotals property.
*
*
* For example, to add a new item, do as follows:
*
* getPaymentTotals().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link PaymentTotals }
*
* @return the payment totals
*/
public List getPaymentTotals() {
if (paymentTotals == null) {
paymentTotals = new ArrayList<>();
}
return this.paymentTotals;
}
/**
* Gets the value of the loyaltyTotals property.
*
*
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
* This is why there is not a set method for the loyaltyTotals property.
*
*
* For example, to add a new item, do as follows:
*
* getLoyaltyTotals().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link LoyaltyTotals }
*
* @return the loyalty totals
*/
public List getLoyaltyTotals() {
if (loyaltyTotals == null) {
loyaltyTotals = new ArrayList<>();
}
return this.loyaltyTotals;
}
/**
* Gets the value of the paymentInstrumentType property.
*
* @return possible object is {@link PaymentInstrumentType }
*/
public PaymentInstrumentType getPaymentInstrumentType() {
return paymentInstrumentType;
}
/**
* Sets the value of the paymentInstrumentType property.
*
* @param value allowed object is {@link PaymentInstrumentType }
*/
public void setPaymentInstrumentType(PaymentInstrumentType value) {
this.paymentInstrumentType = value;
}
/**
* Gets the value of the acquirerID property.
*
* @return possible object is {@link String }
*/
public String getAcquirerID() {
return acquirerID;
}
/**
* Sets the value of the acquirerID property.
*
* @param value allowed object is {@link String }
*/
public void setAcquirerID(String value) {
this.acquirerID = value;
}
/**
* Gets the value of the errorCondition property.
*
* @return possible object is {@link ErrorConditionType }
*/
public ErrorConditionType getErrorCondition() {
return errorCondition;
}
/**
* Sets the value of the errorCondition property.
*
* @param value allowed object is {@link ErrorConditionType }
*/
public void setErrorCondition(ErrorConditionType value) {
this.errorCondition = value;
}
/**
* Gets the value of the hostReconciliationID property.
*
* @return possible object is {@link String }
*/
public String getHostReconciliationID() {
return hostReconciliationID;
}
/**
* Sets the value of the hostReconciliationID property.
*
* @param value allowed object is {@link String }
*/
public void setHostReconciliationID(String value) {
this.hostReconciliationID = value;
}
/**
* Gets the value of the cardBrand property.
*
* @return possible object is {@link String }
*/
public String getCardBrand() {
return cardBrand;
}
/**
* Sets the value of the cardBrand property.
*
* @param value allowed object is {@link String }
*/
public void setCardBrand(String value) {
this.cardBrand = value;
}
/**
* Gets the value of the poiid property.
*
* @return possible object is {@link String }
*/
public String getPOIID() {
return poiid;
}
/**
* Sets the value of the poiid property.
*
* @param value allowed object is {@link String }
*/
public void setPOIID(String value) {
this.poiid = value;
}
/**
* Gets the value of the saleID property.
*
* @return possible object is {@link String }
*/
public String getSaleID() {
return saleID;
}
/**
* Sets the value of the saleID property.
*
* @param value allowed object is {@link String }
*/
public void setSaleID(String value) {
this.saleID = value;
}
/**
* Gets the value of the operatorID property.
*
* @return possible object is {@link String }
*/
public String getOperatorID() {
return operatorID;
}
/**
* Sets the value of the operatorID property.
*
* @param value allowed object is {@link String }
*/
public void setOperatorID(String value) {
this.operatorID = value;
}
/**
* Gets the value of the shiftNumber property.
*
* @return possible object is {@link String }
*/
public String getShiftNumber() {
return shiftNumber;
}
/**
* Sets the value of the shiftNumber property.
*
* @param value allowed object is {@link String }
*/
public void setShiftNumber(String value) {
this.shiftNumber = value;
}
/**
* Gets the value of the totalsGroupID property.
*
* @return possible object is {@link String }
*/
public String getTotalsGroupID() {
return totalsGroupID;
}
/**
* Sets the value of the totalsGroupID property.
*
* @param value allowed object is {@link String }
*/
public void setTotalsGroupID(String value) {
this.totalsGroupID = value;
}
/**
* Gets the value of the paymentCurrency property.
*
* @return possible object is {@link String }
*/
public String getPaymentCurrency() {
return paymentCurrency;
}
/**
* Sets the value of the paymentCurrency property.
*
* @param value allowed object is {@link String }
*/
public void setPaymentCurrency(String value) {
this.paymentCurrency = value;
}
/**
* Gets the value of the loyaltyUnit property.
*
* @return possible object is {@link LoyaltyUnitType }
*/
public LoyaltyUnitType getLoyaltyUnit() {
if (loyaltyUnit == null) {
return LoyaltyUnitType.POINT;
} else {
return loyaltyUnit;
}
}
/**
* Sets the value of the loyaltyUnit property.
*
* @param value allowed object is {@link LoyaltyUnitType }
*/
public void setLoyaltyUnit(LoyaltyUnitType value) {
this.loyaltyUnit = value;
}
/**
* Gets the value of the loyaltyCurrency property.
*
* @return possible object is {@link String }
*/
public String getLoyaltyCurrency() {
return loyaltyCurrency;
}
/**
* Sets the value of the loyaltyCurrency property.
*
* @param value allowed object is {@link String }
*/
public void setLoyaltyCurrency(String value) {
this.loyaltyCurrency = value;
}
}