Class PaymentValidationRequest
java.lang.Object
com.broadleafcommerce.paymentgateway.domain.PaymentValidationRequest
- All Implemented Interfaces:
Serializable
This entity is designed to store payment methods associated to a Cart, the getAmount()
the user is to be charged via that payment method, and the history of attempted transactions
(authorizations, charges, refunds, etc.) against that payment method for the owning Cart.
Every payment gateway interaction should have its results stored in the transactions
collection.
- Author:
- Chad Harchar (charchar), Chris Kittrell (ckittrell)
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddAddress
(String addressType, Address<PaymentValidationRequest> address) Adds anAddress
to the map, identified by the provided addressType.addressByType
(String addressType) protected boolean
boolean
getAddress
(String addressType) Gathers one of the payment's relatedaddresses
by typeThe collection of related addresses that may include billing or shipping addressesjavax.money.MonetaryAmount
The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.javax.money.MonetaryAmount
The amount for which this payment is allotted.General use map to capture any additional attributes needed for this PaymentValidationRequestjavax.money.CurrencyUnit
The currency gathered from thegetAmount()
javax.money.MonetaryAmount
The total fees related to the transactionamount
Note: Only theamount
is required, but if this value is included, then thesubtotal
,fulfillmentTotal
,adjustmentsTotal
,taxTotal
, &includedTaxTotal
should be included also.javax.money.MonetaryAmount
The payment's total fulfillment cost.The gateway used to process this payment.getId()
The id of this payment.javax.money.MonetaryAmount
The amount of taxes that are included in the subtotal (VAT).getName()
The name of this payment.The id of the entity that owns this payment.Describes the owner of the payment.The id of the owning user that owns this payment.Describes the owning user type of the payment.Map to capture any information about the payment method needed to perform gateway transactionsboolean
Deprecated, for removal: This API element is subject to removal in a future version.javax.money.MonetaryAmount
The payment's total usually excluding adjustments, tax, fees, and shipping.javax.money.MonetaryAmount
The payment's total tax cost.Transaction data representing each payment gateway interaction related to this payment.getType()
The type of this payment like Credit Card or Gift Card.The version of this payment.int
hashCode()
boolean
Whether or not the underlying payment method can only be used once.void
setAddressByType
(Map<String, Address<PaymentValidationRequest>> addressByType) The collection of related addresses that may include billing or shipping addressesvoid
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 this payment is allotted.void
setAttributes
(Map<String, String> attributes) General use map to capture any additional attributes needed for this PaymentValidationRequestvoid
setFeesTotal
(javax.money.MonetaryAmount feesTotal) The total fees related to the transactionamount
Note: Only theamount
is required, but if this value is included, then thesubtotal
,fulfillmentTotal
,adjustmentsTotal
,taxTotal
, &includedTaxTotal
should be included also.void
setFulfillmentTotal
(javax.money.MonetaryAmount fulfillmentTotal) The payment's total fulfillment cost.void
setGatewayType
(String gatewayType) The gateway used to process this payment.void
The id of this payment.void
setIncludedTaxTotal
(javax.money.MonetaryAmount includedTaxTotal) The amount of taxes that are included in the subtotal (VAT).void
The name of this payment.void
setOwnerId
(String ownerId) The id of the entity that owns this payment.void
setOwnerType
(String ownerType) Describes the owner of the payment.void
setOwningUserId
(String owningUserId) The id of the owning user that owns this payment.void
setOwningUserType
(String owningUserType) Describes the owning user type of the payment.void
setPaymentMethodProperties
(Map<String, String> paymentMethodProperties) Map to capture any information about the payment method needed to perform gateway transactionsvoid
setShouldSavePaymentForFutureUse
(boolean shouldSavePaymentForFutureUse) Should the payment method be saved to the owning user.void
setShouldSavePaymentToCustomer
(boolean shouldSavePaymentToCustomer) Deprecated.since 1.0.2, in favor ofshouldSavePaymentForFutureUse
to support owning user types other than a customer (i.e.void
setSingleUsePaymentMethod
(boolean singleUsePaymentMethod) Whether or not the underlying payment method can only be used once.void
setSubtotal
(javax.money.MonetaryAmount subtotal) The payment's total usually excluding adjustments, tax, fees, and shipping.void
setTaxTotal
(javax.money.MonetaryAmount taxTotal) The payment's total tax cost.void
setTransactions
(List<PaymentTransaction> transactions) Transaction data representing each payment gateway interaction related to this payment.void
The type of this payment like Credit Card or Gift Card.void
setVersion
(Integer version) The version of this payment.boolean
Should the payment method be saved to the owning usertoString()
-
Constructor Details
-
PaymentValidationRequest
public PaymentValidationRequest()
-
-
Method Details
-
getCurrency
@Nullable public javax.money.CurrencyUnit getCurrency()The currency gathered from thegetAmount()
- Returns:
- The currency gathered from the payment amount
-
addressByType
-
addAddress
public Address<PaymentValidationRequest> addAddress(String addressType, Address<PaymentValidationRequest> address) Adds anAddress
to the map, identified by the provided addressType.- Parameters:
addressType
- The type of address that is to be addedaddress
- The address that is to be added- Returns:
- The address that was added to the map.
-
getAddress
Gathers one of the payment's relatedaddresses
by type- Returns:
- The payment's related address identified by type
-
getShouldSavePaymentToCustomer
Deprecated, for removal: This API element is subject to removal in a future version.since 1.0.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
-
getId
The id of this payment.- Returns:
- The id of this payment.
-
getName
The name of this payment. This name is typically something like "Visa ending in 1234".- Returns:
- The name of this payment.
-
getOwnerType
Describes the owner of the payment. For example, the payment could have originated with a cart or a subscription, therefore this value might be CART or SUBSCRIPTION.- Returns:
- The type describing the owner of the payment
-
getOwnerId
The id of the entity that owns this payment. For example, this may be a cart id, or a subscription billing cycle id.- Returns:
- The id of the entity that owns this payment.
-
getOwningUserType
Describes the owning user type of the payment. For example, the payment could belong to a customer, therefore this value might be BLC_CUSTOMER.- Returns:
- The type describing the owning user of the payment
-
getOwningUserId
The id of the owning user that owns this payment. For example, this may be a customer id.- Returns:
- The id of the owning user that owns this payment.
-
getType
The type of this payment like Credit Card or Gift Card.- Returns:
- The type of this payment like Credit Card or Gift Card.
-
getGatewayType
The gateway used to process this payment. Only a SINGLE payment gateway can modify transactions on a particular payment.- Returns:
- The gateway used to process 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 theamount
is required, but if this value is included, then thefulfillmentTotal
,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 theamount
is required, but if this value is included, then thesubtotal
,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 theamount
is required, but if this value is included, then thesubtotal
,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 transactionamount
Note: Only theamount
is required, but if this value is included, then thesubtotal
,fulfillmentTotal
,adjustmentsTotal
,taxTotal
, &includedTaxTotal
should be included also.- Returns:
- The total fees related to the transaction
amount
-
getTaxTotal
public javax.money.MonetaryAmount getTaxTotal()The payment's total tax cost. Note: Only theamount
is required, but if this value is included, then thesubtotal
,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 theamount
is required, but if this value is included, then thesubtotal
,fulfillmentTotal
,feesTotal
,adjustmentsTotal
, &taxTotal
should be included also.- Returns:
- The amount of taxes that are included in the subtotal (VAT).
-
getAddressByType
The collection of related addresses that may include billing or shipping addresses- Returns:
- The collection of related addresses
-
getPaymentMethodProperties
Map to capture any information about the payment method needed to perform gateway transactions- Returns:
- Map to capture any information about the payment method needed to perform gateway transactions
-
getAttributes
General use map to capture any additional attributes needed for this PaymentValidationRequest- Returns:
- General use map to capture any additional attributes needed for this PaymentValidationRequest
-
getTransactions
Transaction data representing each payment gateway interaction related to this payment.- Returns:
- Transactions related to this payment.
-
isSingleUsePaymentMethod
public boolean isSingleUsePaymentMethod()Whether or not the underlying payment method can only be used once. In most cases, we're managing a single-use token that represents a credit card. This flag is especially important for managing payments with successful transactions. In those cases, the token has already been used and cannot be reused. If we need modify the payment's amount, then we may actually need to archive the existing payment, and create a new payment, with a new underlying token. Additionally, this flag is helpful when needing to re-authorize an expired authorization transaction. In that case, if the payment represents a single-use payment method, then the re-authorization may not be possible, and you'll need to seek an alternative form of payment.- Returns:
- Whether or not the underlying payment method can only be used once
-
getVersion
The version of this payment. Used for checking that the requested version of the payment is up-to-date before saving changes. Required for any request which results in an update being made to the payment. This should never be manually incremented/decremented. -
setId
The id of this payment.- Parameters:
id
- The id of this payment.
-
setName
The name of this payment. This name is typically something like "Visa ending in 1234".- Parameters:
name
- The name of this payment.
-
setOwnerType
Describes the owner of the payment. For example, the payment could have originated with a cart or a subscription, therefore this value might be CART or SUBSCRIPTION.- Parameters:
ownerType
- The type describing the owner of the payment
-
setOwnerId
The id of the entity that owns this payment. For example, this may be a cart id, or a subscription billing cycle id.- Parameters:
ownerId
- The id of the entity that owns this payment.
-
setOwningUserType
Describes the owning user type of the payment. For example, the payment could belong to a customer, therefore this value might be BLC_CUSTOMER.- Parameters:
owningUserType
- The type describing the owning user of the payment
-
setOwningUserId
The id of the owning user that owns this payment. For example, this may be a customer id.- Parameters:
owningUserId
- The id of the owning user that owns this payment.
-
setType
The type of this payment like Credit Card or Gift Card.- Parameters:
type
- The type of this payment like Credit Card or Gift Card.
-
setGatewayType
The gateway used to process this payment. Only a SINGLE payment gateway can modify transactions on a particular payment.- Parameters:
gatewayType
- The gateway used to process this payment.
-
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 theamount
is required, but if this value is included, then thefulfillmentTotal
,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 theamount
is required, but if this value is included, then thesubtotal
,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 theamount
is required, but if this value is included, then thesubtotal
,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 transactionamount
Note: Only theamount
is required, but if this value is included, then thesubtotal
,fulfillmentTotal
,adjustmentsTotal
,taxTotal
, &includedTaxTotal
should be included also.- Parameters:
feesTotal
- The total fees related to the transactionamount
-
setTaxTotal
public void setTaxTotal(javax.money.MonetaryAmount taxTotal) The payment's total tax cost. Note: Only theamount
is required, but if this value is included, then thesubtotal
,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 theamount
is required, but if this value is included, then thesubtotal
,fulfillmentTotal
,feesTotal
,adjustmentsTotal
, &taxTotal
should be included also.- Parameters:
includedTaxTotal
- The amount of taxes that are included in the subtotal (VAT).
-
setAddressByType
The collection of related addresses that may include billing or shipping addresses- Parameters:
addressByType
- The collection of related addresses
-
setPaymentMethodProperties
Map to capture any information about the payment method needed to perform gateway transactions- Parameters:
paymentMethodProperties
- Map to capture any information about the payment method needed to perform gateway transactions
-
setAttributes
General use map to capture any additional attributes needed for this PaymentValidationRequest- Parameters:
attributes
- General use map to capture any additional attributes needed for this PaymentValidationRequest
-
setTransactions
Transaction data representing each payment gateway interaction related to this payment.- Parameters:
transactions
- Transactions related to this payment.
-
setSingleUsePaymentMethod
public void setSingleUsePaymentMethod(boolean singleUsePaymentMethod) Whether or not the underlying payment method can only be used once. In most cases, we're managing a single-use token that represents a credit card. This flag is especially important for managing payments with successful transactions. In those cases, the token has already been used and cannot be reused. If we need modify the payment's amount, then we may actually need to archive the existing payment, and create a new payment, with a new underlying token. Additionally, this flag is helpful when needing to re-authorize an expired authorization transaction. In that case, if the payment represents a single-use payment method, then the re-authorization may not be possible, and you'll need to seek an alternative form of payment.- Parameters:
singleUsePaymentMethod
- Whether or not the underlying payment method can only be used once
-
setShouldSavePaymentToCustomer
Deprecated.since 1.0.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
-
setVersion
The version of this payment. Used for checking that the requested version of the payment is up-to-date before saving changes. Required for any request which results in an update being made to the payment. This should never be manually incremented/decremented. -
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-
shouldSavePaymentForFutureUse()
to support owning user types other than a customer (i.e.