Class UpdatePaymentRequest
java.lang.Object
com.broadleafcommerce.cartoperation.web.endpoint.domain.UpdatePaymentRequest
- All Implemented Interfaces:
Serializable
A request DTO used to update the payment for the resolved
Cart
.- Author:
- Chad Harchar (charchar)
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
The list of restrictions that apply to payment access.javax.money.MonetaryAmount
The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.javax.money.MonetaryAmount
The amount for which the payment is allotted.Map to capture any additional information about the paymentcom.broadleafcommerce.order.common.domain.Address
The billing address associated with this payment.General use map to capture any display properties for this Paymentjavax.money.MonetaryAmount
The payment's total fulfillment costgetName()
The name of this payment.The ID of the payment to update.javax.money.MonetaryAmount
The payment's total usually excluding adjustments, tax, and shipping.javax.money.MonetaryAmount
The payment's total tax costint
hashCode()
boolean
Declares whether the payment's transactions should be marked ineligible for automatic reversal.void
setAccessRestrictions
(List<String> accessRestrictions) The list of restrictions that apply to payment access.void
setAdjustmentsTotal
(javax.money.MonetaryAmount adjustmentsTotal) The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.void
setAmount
(javax.money.MonetaryAmount amount) The amount for which the payment is allotted.void
setAttributes
(Map<String, String> attributes) Map to capture any additional information about the paymentvoid
setBillingAddress
(com.broadleafcommerce.order.common.domain.Address billingAddress) The billing address associated with this payment.void
setDisplayAttributes
(Map<String, String> displayAttributes) General use map to capture any display properties for this Paymentvoid
setFulfillmentTotal
(javax.money.MonetaryAmount fulfillmentTotal) The payment's total fulfillment costvoid
setMarkTransactionsIneligibleForAutomaticReversal
(boolean markTransactionsIneligibleForAutomaticReversal) Declares whether the payment's transactions should be marked ineligible for automatic reversal.void
The name of this payment.void
setPaymentId
(String paymentId) The ID of the payment to update.void
setShouldSavePaymentForFutureUse
(boolean shouldSavePaymentForFutureUse) Should the payment method be saved to the owning user.void
setShouldSavePaymentToCustomer
(Boolean shouldSavePaymentToCustomer) Deprecated.void
setSubtotal
(javax.money.MonetaryAmount subtotal) The payment's total usually excluding adjustments, tax, and shipping.void
setTaxTotal
(javax.money.MonetaryAmount taxTotal) The payment's total tax costboolean
Should the payment method be saved to the owning userDeprecated, for removal: This API element is subject to removal in a future version.since 1.7.2, in favor ofshouldSavePaymentForFutureUse()
to support owning user types other than a customer (i.e.toString()
-
Constructor Details
-
UpdatePaymentRequest
public UpdatePaymentRequest()
-
-
Method Details
-
shouldSavePaymentToCustomer
Deprecated, for removal: This API element is subject to removal in a future version.since 1.7.2, in favor ofshouldSavePaymentForFutureUse()
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
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
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 the payment is allotted.- Returns:
- The amount for which the payment is allotted.
-
getSubtotal
public javax.money.MonetaryAmount getSubtotal()The payment's total usually excluding adjustments, tax, and shipping.- Returns:
- The payment's total usually excluding adjustments, tax, and shipping.
-
getAdjustmentsTotal
public javax.money.MonetaryAmount getAdjustmentsTotal()The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.- 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- Returns:
- The payment's total fulfillment cost
-
getTaxTotal
public javax.money.MonetaryAmount getTaxTotal()The payment's total tax cost- Returns:
- The payment's total tax cost
-
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
Map to capture any additional information about the payment- Returns:
- Map to capture any additional information about the payment
-
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
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
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
The name of this payment. This name is typically something like "Visa ending in 1234".- Parameters:
name
- The name of this payment.
-
setShouldSavePaymentToCustomer
Deprecated.since 1.7.2, in favor ofshouldSavePaymentForFutureUse
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 the payment is allotted.- Parameters:
amount
- The amount for which the payment is allotted.
-
setSubtotal
public void setSubtotal(javax.money.MonetaryAmount subtotal) The payment's total usually excluding adjustments, tax, and shipping. -
setAdjustmentsTotal
public void setAdjustmentsTotal(javax.money.MonetaryAmount 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 -
setTaxTotal
public void setTaxTotal(javax.money.MonetaryAmount taxTotal) The payment's total tax cost -
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
Map to capture any additional information about the payment- Parameters:
attributes
- Map to capture any additional information about the payment
-
setDisplayAttributes
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
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
-
canEqual
-
hashCode
public int hashCode() -
toString
-
shouldSavePaymentForFutureUse
to support owning user types other than a customer (i.e.