Package com.broadleafcommerce.cartoperation.web.endpoint.domain

Class UpdatePaymentRequest

java.lang.Object
com.broadleafcommerce.cartoperation.web.endpoint.domain.UpdatePaymentRequest
All Implemented Interfaces:
Serializable
public class UpdatePaymentRequest extends Object implements Serializable
A request DTO used to update the payment for the resolved Cart.
Author:
Chad Harchar (charchar)
See Also:

  • Constructor Details

    • UpdatePaymentRequest

      public UpdatePaymentRequest()

  • Method Details

    • shouldSavePaymentToCustomer

      @Deprecated(since="1.7.2", forRemoval=true) public Boolean shouldSavePaymentToCustomer()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1.7.2, in favor of shouldSavePaymentForFutureUse() to support owning user types other than a customer (i.e. account).

    • shouldSavePaymentForFutureUse

      public boolean shouldSavePaymentForFutureUse()
      Should the payment method be saved to the owning user
      Returns:
      Should the payment method be saved to the owning user

    • getPaymentId

      public String getPaymentId()
      The ID of the payment to update. Will be pre-populated in Cart Operations from the request.
      Returns:
      the payment ID this update is for

    • getName

      public String getName()
      The name of this payment. This name is typically something like "Visa ending in 1234".
      Returns:
      The name of this payment.

    • getAmount

      public javax.money.MonetaryAmount getAmount()
      The amount for which this payment is allotted.

      If specified, the amount details should be equal to this amount using the following equation: transactionAmount = subtotal + fulfillmentTotal + feesTotal - adjustmentsTotal + taxTotal - includedTaxTotal.

      Returns:
      The amount for which this payment is allotted.

    • getSubtotal

      public javax.money.MonetaryAmount getSubtotal()
      The payment's total usually excluding adjustments, tax, fees, and shipping.

      Note: Only the amount is required, but if this value is included, then the fulfillmentTotal, feesTotal, adjustmentsTotal, taxTotal, & includedTaxTotal should be included also.

      Returns:
      The payment's total usually excluding adjustments, tax, fees, and shipping.

    • getAdjustmentsTotal

      public javax.money.MonetaryAmount getAdjustmentsTotal()
      The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts. Note: Only the amount is required, but if this value is included, then the subtotal, fulfillmentTotal, feesTotal, taxTotal, & includedTaxTotal should be included also.
      Returns:
      The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.

    • getFulfillmentTotal

      public javax.money.MonetaryAmount getFulfillmentTotal()
      The payment's total fulfillment cost.

      Note: Only the amount is required, but if this value is included, then the subtotal, feesTotal, adjustmentsTotal, taxTotal, & includedTaxTotal should be included also.

      Returns:
      The payment's total fulfillment cost.

    • getFeesTotal

      public javax.money.MonetaryAmount getFeesTotal()
      The total fees related to the transaction amount

      Note: Only the amount is required, but if this value is included, then the subtotal, fulfillmentTotal, adjustmentsTotal, taxTotal, & includedTaxTotal should be included also.

      Returns:
      The total fees related to the transaction amount
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0

    • getTaxTotal

      public javax.money.MonetaryAmount getTaxTotal()
      The payment's total tax cost.

      Note: Only the amount is required, but if this value is included, then the subtotal, fulfillmentTotal, feesTotal, adjustmentsTotal, & includedTaxTotal should be included also.

      Returns:
      The payment's total tax cost.

    • getIncludedTaxTotal

      public javax.money.MonetaryAmount getIncludedTaxTotal()
      The amount of taxes that are included in the subtotal (VAT).

      Note: Only the amount is required, but if this value is included, then the subtotal, fulfillmentTotal, feesTotal, adjustmentsTotal, & taxTotal should be included also.

      Returns:
      The amount of taxes that are included in the subtotal (VAT).
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0

    • getBillingAddress

      public com.broadleafcommerce.order.common.domain.Address getBillingAddress()
      The billing address associated with this payment.
      Returns:
      The billing address associated with this payment.

    • getAttributes

      public Map<String,String> getAttributes()
      Map to capture any additional information about the payment
      Returns:
      Map to capture any additional information about the payment

    • getDisplayAttributes

      public Map<String,String> getDisplayAttributes()
      General use map to capture any display properties for this Payment
      Returns:
      General use map to capture any display properties for this Payment

    • getAccessRestrictions

      public List<String> getAccessRestrictions()
      The list of restrictions that apply to payment access.
      Returns:
      the list of restrictions that apply to payment access

    • isMarkTransactionsIneligibleForAutomaticReversal

      public boolean isMarkTransactionsIneligibleForAutomaticReversal()
      Declares whether the payment's transactions should be marked ineligible for automatic reversal.
      Returns:
      whether the payment's transactions should be marked ineligible for automatic reversal.

    • setPaymentId

      public void setPaymentId(String paymentId)
      The ID of the payment to update. Will be pre-populated in Cart Operations from the request.
      Parameters:
      paymentId - the payment ID this update is for

    • setName

      public void setName(String name)
      The name of this payment. This name is typically something like "Visa ending in 1234".
      Parameters:
      name - The name of this payment.

    • setShouldSavePaymentToCustomer

      @Deprecated public void setShouldSavePaymentToCustomer(Boolean shouldSavePaymentToCustomer)
      Deprecated.
      since 1.7.2, in favor of shouldSavePaymentForFutureUse to support owning user types other than a customer (i.e. account).

    • setShouldSavePaymentForFutureUse

      public void setShouldSavePaymentForFutureUse(boolean shouldSavePaymentForFutureUse)
      Should the payment method be saved to the owning user.
      Parameters:
      shouldSavePaymentForFutureUse - Should the payment method be saved to the owning user

    • setAmount

      public void setAmount(javax.money.MonetaryAmount amount)
      The amount for which this payment is allotted.

      If specified, the amount details should be equal to this amount using the following equation: transactionAmount = subtotal + fulfillmentTotal + feesTotal - adjustmentsTotal + taxTotal - includedTaxTotal.

      Parameters:
      amount - The amount for which this payment is allotted.

    • setSubtotal

      public void setSubtotal(javax.money.MonetaryAmount subtotal)
      The payment's total usually excluding adjustments, tax, fees, and shipping.

      Note: Only the amount is required, but if this value is included, then the fulfillmentTotal, feesTotal, adjustmentsTotal, taxTotal, & includedTaxTotal should be included also.

      Parameters:
      subtotal - The payment's total usually excluding adjustments, tax, fees, and shipping.

    • setAdjustmentsTotal

      public void setAdjustmentsTotal(javax.money.MonetaryAmount adjustmentsTotal)
      The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts. Note: Only the amount is required, but if this value is included, then the subtotal, fulfillmentTotal, feesTotal, taxTotal, & includedTaxTotal should be included also.
      Parameters:
      adjustmentsTotal - The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.

    • setFulfillmentTotal

      public void setFulfillmentTotal(javax.money.MonetaryAmount fulfillmentTotal)
      The payment's total fulfillment cost.

      Note: Only the amount is required, but if this value is included, then the subtotal, feesTotal, adjustmentsTotal, taxTotal, & includedTaxTotal should be included also.

      Parameters:
      fulfillmentTotal - The payment's total fulfillment cost.

    • setFeesTotal

      public void setFeesTotal(javax.money.MonetaryAmount feesTotal)
      The total fees related to the transaction amount

      Note: Only the amount is required, but if this value is included, then the subtotal, fulfillmentTotal, adjustmentsTotal, taxTotal, & includedTaxTotal should be included also.

      Parameters:
      feesTotal - The total fees related to the transaction amount
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0

    • setTaxTotal

      public void setTaxTotal(javax.money.MonetaryAmount taxTotal)
      The payment's total tax cost.

      Note: Only the amount is required, but if this value is included, then the subtotal, fulfillmentTotal, feesTotal, adjustmentsTotal, & includedTaxTotal should be included also.

      Parameters:
      taxTotal - The payment's total tax cost.

    • setIncludedTaxTotal

      public void setIncludedTaxTotal(javax.money.MonetaryAmount includedTaxTotal)
      The amount of taxes that are included in the subtotal (VAT).

      Note: Only the amount is required, but if this value is included, then the subtotal, fulfillmentTotal, feesTotal, adjustmentsTotal, & taxTotal should be included also.

      Parameters:
      includedTaxTotal - The amount of taxes that are included in the subtotal (VAT).
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0

    • setBillingAddress

      public void setBillingAddress(com.broadleafcommerce.order.common.domain.Address billingAddress)
      The billing address associated with this payment.
      Parameters:
      billingAddress - The billing address associated with this payment.

    • setAttributes

      public void setAttributes(Map<String,String> attributes)
      Map to capture any additional information about the payment
      Parameters:
      attributes - Map to capture any additional information about the payment

    • setDisplayAttributes

      public void setDisplayAttributes(Map<String,String> displayAttributes)
      General use map to capture any display properties for this Payment
      Parameters:
      displayAttributes - General use map to capture any display properties for this Payment

    • setAccessRestrictions

      public void setAccessRestrictions(List<String> accessRestrictions)
      The list of restrictions that apply to payment access.
      Parameters:
      accessRestrictions - the list of restrictions that apply to payment access

    • setMarkTransactionsIneligibleForAutomaticReversal

      public void setMarkTransactionsIneligibleForAutomaticReversal(boolean markTransactionsIneligibleForAutomaticReversal)
      Declares whether the payment's transactions should be marked ineligible for automatic reversal.
      Parameters:
      markTransactionsIneligibleForAutomaticReversal - whether the payment's transactions should be marked ineligible for automatic reversal.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object