Class TransactionTotals


  • public class TransactionTotals
    extends Object
    If Result is Success, contains all the totals, classified as required by the Sale in the message request. At least, transaction totals are provided per Acquirer, Acquirer Settlement, and Card Brand. Result of the Sale to POI Reconciliation processing.
    • Constructor Detail

      • TransactionTotals

        public TransactionTotals()
    • Method Detail

      • paymentInstrumentType

        public TransactionTotals paymentInstrumentType​(PaymentInstrumentType paymentInstrumentType)
        paymentInstrumentType
        Parameters:
        paymentInstrumentType -
        Returns:
        the current TransactionTotals instance, allowing for method chaining
      • getPaymentInstrumentType

        public PaymentInstrumentType getPaymentInstrumentType()
        Get paymentInstrumentType
        Returns:
        paymentInstrumentType
      • setPaymentInstrumentType

        public void setPaymentInstrumentType​(PaymentInstrumentType paymentInstrumentType)
        paymentInstrumentType
        Parameters:
        paymentInstrumentType -
      • acquirerID

        public TransactionTotals acquirerID​(Integer acquirerID)
        Identification of the Acquirer.
        Parameters:
        acquirerID - Identification of the Acquirer.
        Returns:
        the current TransactionTotals instance, allowing for method chaining
      • getAcquirerID

        public Integer getAcquirerID()
        Identification of the Acquirer.
        Returns:
        acquirerID Identification of the Acquirer.
      • setAcquirerID

        public void setAcquirerID​(Integer acquirerID)
        Identification of the Acquirer.
        Parameters:
        acquirerID - Identification of the Acquirer.
      • hostReconciliationID

        public TransactionTotals hostReconciliationID​(String hostReconciliationID)
        Identifier of a reconciliation period with a payment or loyalty host.
        Parameters:
        hostReconciliationID - Identifier of a reconciliation period with a payment or loyalty host.
        Returns:
        the current TransactionTotals instance, allowing for method chaining
      • getHostReconciliationID

        public String getHostReconciliationID()
        Identifier of a reconciliation period with a payment or loyalty host.
        Returns:
        hostReconciliationID Identifier of a reconciliation period with a payment or loyalty host.
      • setHostReconciliationID

        public void setHostReconciliationID​(String hostReconciliationID)
        Identifier of a reconciliation period with a payment or loyalty host.
        Parameters:
        hostReconciliationID - Identifier of a reconciliation period with a payment or loyalty host.
      • cardBrand

        public TransactionTotals cardBrand​(String cardBrand)
        Type of payment or loyalty card. If configured to present totals per card brand, and Response.Result is Success.
        Parameters:
        cardBrand - Type of payment or loyalty card. If configured to present totals per card brand, and Response.Result is Success.
        Returns:
        the current TransactionTotals instance, allowing for method chaining
      • getCardBrand

        public String getCardBrand()
        Type of payment or loyalty card. If configured to present totals per card brand, and Response.Result is Success.
        Returns:
        cardBrand Type of payment or loyalty card. If configured to present totals per card brand, and Response.Result is Success.
      • setCardBrand

        public void setCardBrand​(String cardBrand)
        Type of payment or loyalty card. If configured to present totals per card brand, and Response.Result is Success.
        Parameters:
        cardBrand - Type of payment or loyalty card. If configured to present totals per card brand, and Response.Result is Success.
      • POIID

        public TransactionTotals POIID​(String POIID)
        Identification of a POI System or a POI Terminal for the Sale to POI protocol. Sent if requested in the message request.
        Parameters:
        POIID - Identification of a POI System or a POI Terminal for the Sale to POI protocol. Sent if requested in the message request.
        Returns:
        the current TransactionTotals instance, allowing for method chaining
      • getPOIID

        public String getPOIID()
        Identification of a POI System or a POI Terminal for the Sale to POI protocol. Sent if requested in the message request.
        Returns:
        POIID Identification of a POI System or a POI Terminal for the Sale to POI protocol. Sent if requested in the message request.
      • setPOIID

        public void setPOIID​(String POIID)
        Identification of a POI System or a POI Terminal for the Sale to POI protocol. Sent if requested in the message request.
        Parameters:
        POIID - Identification of a POI System or a POI Terminal for the Sale to POI protocol. Sent if requested in the message request.
      • saleID

        public TransactionTotals saleID​(String saleID)
        Identification of a Sale System or a Sale Terminal for the Sale to POI protocol. Sent if requested in the message request.
        Parameters:
        saleID - Identification of a Sale System or a Sale Terminal for the Sale to POI protocol. Sent if requested in the message request.
        Returns:
        the current TransactionTotals instance, allowing for method chaining
      • getSaleID

        public String getSaleID()
        Identification of a Sale System or a Sale Terminal for the Sale to POI protocol. Sent if requested in the message request.
        Returns:
        saleID Identification of a Sale System or a Sale Terminal for the Sale to POI protocol. Sent if requested in the message request.
      • setSaleID

        public void setSaleID​(String saleID)
        Identification of a Sale System or a Sale Terminal for the Sale to POI protocol. Sent if requested in the message request.
        Parameters:
        saleID - Identification of a Sale System or a Sale Terminal for the Sale to POI protocol. Sent if requested in the message request.
      • operatorID

        public TransactionTotals operatorID​(String operatorID)
        Identification of the Cashier or Operator. Sent if requested in the message request.
        Parameters:
        operatorID - Identification of the Cashier or Operator. Sent if requested in the message request.
        Returns:
        the current TransactionTotals instance, allowing for method chaining
      • getOperatorID

        public String getOperatorID()
        Identification of the Cashier or Operator. Sent if requested in the message request.
        Returns:
        operatorID Identification of the Cashier or Operator. Sent if requested in the message request.
      • setOperatorID

        public void setOperatorID​(String operatorID)
        Identification of the Cashier or Operator. Sent if requested in the message request.
        Parameters:
        operatorID - Identification of the Cashier or Operator. Sent if requested in the message request.
      • shiftNumber

        public TransactionTotals shiftNumber​(String shiftNumber)
        Shift number. Sent if requested in the message request.
        Parameters:
        shiftNumber - Shift number. Sent if requested in the message request.
        Returns:
        the current TransactionTotals instance, allowing for method chaining
      • getShiftNumber

        public String getShiftNumber()
        Shift number. Sent if requested in the message request.
        Returns:
        shiftNumber Shift number. Sent if requested in the message request.
      • setShiftNumber

        public void setShiftNumber​(String shiftNumber)
        Shift number. Sent if requested in the message request.
        Parameters:
        shiftNumber - Shift number. Sent if requested in the message request.
      • totalsGroupID

        public TransactionTotals totalsGroupID​(String totalsGroupID)
        Identification of a group of transaction on a POI Terminal, having the same Sale features. Sent if requested in the message request.
        Parameters:
        totalsGroupID - Identification of a group of transaction on a POI Terminal, having the same Sale features. Sent if requested in the message request.
        Returns:
        the current TransactionTotals instance, allowing for method chaining
      • getTotalsGroupID

        public String getTotalsGroupID()
        Identification of a group of transaction on a POI Terminal, having the same Sale features. Sent if requested in the message request.
        Returns:
        totalsGroupID Identification of a group of transaction on a POI Terminal, having the same Sale features. Sent if requested in the message request.
      • setTotalsGroupID

        public void setTotalsGroupID​(String totalsGroupID)
        Identification of a group of transaction on a POI Terminal, having the same Sale features. Sent if requested in the message request.
        Parameters:
        totalsGroupID - Identification of a group of transaction on a POI Terminal, having the same Sale features. Sent if requested in the message request.
      • paymentCurrency

        public TransactionTotals paymentCurrency​(String paymentCurrency)
        Currency of a monetary amount.
        Parameters:
        paymentCurrency - Currency of a monetary amount.
        Returns:
        the current TransactionTotals instance, allowing for method chaining
      • getPaymentCurrency

        public String getPaymentCurrency()
        Currency of a monetary amount.
        Returns:
        paymentCurrency Currency of a monetary amount.
      • setPaymentCurrency

        public void setPaymentCurrency​(String paymentCurrency)
        Currency of a monetary amount.
        Parameters:
        paymentCurrency - Currency of a monetary amount.
      • paymentTotals

        public TransactionTotals paymentTotals​(List<PaymentTotals> paymentTotals)
        Totals of the payment transaction during the reconciliation period. If both `TransactionCount` and `TransactionAmount` are not equal to zero.
        Parameters:
        paymentTotals - Totals of the payment transaction during the reconciliation period. If both `TransactionCount` and `TransactionAmount` are not equal to zero.
        Returns:
        the current TransactionTotals instance, allowing for method chaining
      • getPaymentTotals

        public List<PaymentTotals> getPaymentTotals()
        Totals of the payment transaction during the reconciliation period. If both `TransactionCount` and `TransactionAmount` are not equal to zero.
        Returns:
        paymentTotals Totals of the payment transaction during the reconciliation period. If both `TransactionCount` and `TransactionAmount` are not equal to zero.
      • setPaymentTotals

        public void setPaymentTotals​(List<PaymentTotals> paymentTotals)
        Totals of the payment transaction during the reconciliation period. If both `TransactionCount` and `TransactionAmount` are not equal to zero.
        Parameters:
        paymentTotals - Totals of the payment transaction during the reconciliation period. If both `TransactionCount` and `TransactionAmount` are not equal to zero.
      • includeNullValues

        public TransactionTotals includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.
      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.
      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
      • equals

        public boolean equals​(Object o)
        Return true if this TransactionTotals object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.
      • fromJson

        public static TransactionTotals fromJson​(String jsonString)
                                          throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of TransactionTotals given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of TransactionTotals
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to TransactionTotals
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of TransactionTotals to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException