Package com.broadleafcommerce.paymenttransaction.web.endpoint.domain

Class SavedPaymentMethodTransactionExecutionRequest

java.lang.Object
com.broadleafcommerce.paymenttransaction.web.endpoint.domain.SavedPaymentMethodTransactionExecutionRequest
All Implemented Interfaces:
Serializable
public class SavedPaymentMethodTransactionExecutionRequest extends Object implements Serializable
The request payload used to execute a transaction against a Payment.
Since:
PaymentTransactionServices 2.1.0, Release Train 2.3.0
Author:
Chris Kittrell (ckittrell)
See Also:

  • Constructor Details

    • SavedPaymentMethodTransactionExecutionRequest

      public SavedPaymentMethodTransactionExecutionRequest()

  • Method Details

    • getTransactionExecutionRequest

      public TransactionExecutionRequest getTransactionExecutionRequest()

    • getPaymentOwningEntityType

      public String getPaymentOwningEntityType()
      Describes the owning entity 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 owning entity of the payment

    • getPaymentOwningEntityId

      public String getPaymentOwningEntityId()
      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.

    • getPaymentOwningUserType

      public String getPaymentOwningUserType()
      Describes the owning user of the payment.
      Returns:
      The type describing the owning user of the payment

    • getPaymentOwningUserId

      public String getPaymentOwningUserId()
      The id of the user that owns this payment.
      Returns:
      The id of the user that owns this payment.

    • getPaymentAttributes

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

    • setTransactionExecutionRequest

      public void setTransactionExecutionRequest(TransactionExecutionRequest transactionExecutionRequest)

    • setPaymentOwningEntityType

      public void setPaymentOwningEntityType(String paymentOwningEntityType)
      Describes the owning entity 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 owning entity of the payment

    • setPaymentOwningEntityId

      public void setPaymentOwningEntityId(String paymentOwningEntityId)
      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.

    • setPaymentOwningUserType

      public void setPaymentOwningUserType(String paymentOwningUserType)
      Describes the owning user of the payment.
      Parameters:
      ownerType - The type describing the owning user of the payment

    • setPaymentOwningUserId

      public void setPaymentOwningUserId(String paymentOwningUserId)
      The id of the user that owns this payment.
      Parameters:
      ownerId - The id of the user that owns this payment.

    • setPaymentAttributes

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

    • 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

    • getCurrency

      public javax.money.CurrencyUnit getCurrency()

    • hasParentSourceEntityTypeAndId

      public boolean hasParentSourceEntityTypeAndId()

    • getIncludedTaxTotal

      public javax.money.MonetaryAmount getIncludedTaxTotal()

    • getSourceEntityId

      @Deprecated public String getSourceEntityId()
      Deprecated.

    • setSourceEntityId

      @Deprecated public void setSourceEntityId(String sourceEntityId)
      Deprecated.

    • getPaymentId

      public String getPaymentId()

    • getSource

      public String getSource()

    • getParentTransactionId

      public String getParentTransactionId()

    • getParentSourceEntityType

      public String getParentSourceEntityType()

    • getParentSourceEntityId

      public String getParentSourceEntityId()

    • getSourceEntityType

      public String getSourceEntityType()

    • getSourceEntityIds

      public List<String> getSourceEntityIds()

    • getTransactionType

      public String getTransactionType()

    • getTransactionManagementState

      public String getTransactionManagementState()

    • isAllowAutomaticReversal

      public boolean isAllowAutomaticReversal()

    • getTransactionAmount

      public javax.money.MonetaryAmount getTransactionAmount()

    • getSubtotal

      public javax.money.MonetaryAmount getSubtotal()

    • getAdjustmentsTotal

      public javax.money.MonetaryAmount getAdjustmentsTotal()

    • getFulfillmentTotal

      public javax.money.MonetaryAmount getFulfillmentTotal()

    • getFeesTotal

      public javax.money.MonetaryAmount getFeesTotal()

    • getTaxTotal

      public javax.money.MonetaryAmount getTaxTotal()

    • getLineItems

      public List<TransactionLineItem> getLineItems()

    • getSecurityCode

      public String getSecurityCode()

    • getPaymentMethodProperties

      public Map<String,Object> getPaymentMethodProperties()

    • getRequestId

      public String getRequestId()

    • setPaymentId

      public void setPaymentId(String paymentId)

    • setSource

      public void setSource(String source)

    • setParentTransactionId

      public void setParentTransactionId(String parentTransactionId)

    • setParentSourceEntityType

      public void setParentSourceEntityType(String parentSourceEntityType)

    • setParentSourceEntityId

      public void setParentSourceEntityId(String parentSourceEntityId)

    • setSourceEntityType

      public void setSourceEntityType(String sourceEntityType)

    • setSourceEntityIds

      public void setSourceEntityIds(List<String> sourceEntityIds)

    • setTransactionType

      public void setTransactionType(String transactionType)

    • setTransactionManagementState

      public void setTransactionManagementState(String transactionManagementState)

    • setAllowAutomaticReversal

      public void setAllowAutomaticReversal(boolean allowAutomaticReversal)

    • setTransactionAmount

      public void setTransactionAmount(javax.money.MonetaryAmount transactionAmount)

    • setSubtotal

      public void setSubtotal(javax.money.MonetaryAmount subtotal)

    • setAdjustmentsTotal

      public void setAdjustmentsTotal(javax.money.MonetaryAmount adjustmentsTotal)

    • setFulfillmentTotal

      public void setFulfillmentTotal(javax.money.MonetaryAmount fulfillmentTotal)

    • setFeesTotal

      public void setFeesTotal(javax.money.MonetaryAmount feesTotal)

    • setTaxTotal

      public void setTaxTotal(javax.money.MonetaryAmount taxTotal)

    • setIncludedTaxTotal

      public void setIncludedTaxTotal(javax.money.MonetaryAmount includedTaxTotal)

    • setLineItems

      public void setLineItems(List<TransactionLineItem> lineItems)

    • setSecurityCode

      public void setSecurityCode(String securityCode)

    • setPaymentMethodProperties

      public void setPaymentMethodProperties(Map<String,Object> paymentMethodProperties)

    • setRequestId

      public void setRequestId(String requestId)