Package com.broadleafcommerce.billing.domain

Class PaymentTransactionDetail

java.lang.Object
com.broadleafcommerce.billing.domain.PaymentTransactionDetail
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware
public class PaymentTransactionDetail extends Object implements com.broadleafcommerce.data.tracking.core.ContextStateAware
This represents a single transaction's state and results.

  • Constructor Details

  • Method Details

    • getAdditionalField

      @Nullable public String getAdditionalField(String key)

    • getId

      public String getId()

    • getPaymentAccountId

      public String getPaymentAccountId()
      Reference to the PaymentAccount used for the transaction

    • getPaymentAccountName

      public String getPaymentAccountName()
      Display name of the payment account from the user’s wallet

    • getPaymentAccountType

      public String getPaymentAccountType()
      The type of the payment account from the user’s wallet

    • getPaymentProcessor

      public String getPaymentProcessor()
      Code for the payment processor used for the transaction. Ex: CYBERSOURCE, PAYPAL

    • getBillingEventPaymentId

      public String getBillingEventPaymentId()
      Reference to the related BillingEventPayment

    • getTransactionType

      public String getTransactionType()
      Transaction type of the transaction
      See Also:

    • getAmount

      public BigDecimal getAmount()
      The monetary amount of this transaction

    • getDateProcessed

      public Date getDateProcessed()
      The date and time this transaction was sent to the processor

    • getDateRecorded

      public Date getDateRecorded()
      The date and time the processor response was recorded

    • getRawResponse

      public String getRawResponse()
      The raw response from the payment processor

    • getProcessingResult

      public ProcessingResultEnum getProcessingResult()
      Result of this transaction

    • getFailureReason

      public String getFailureReason()
      Reason for the transaction failure if available

    • getTransactionReferenceId

      public String getTransactionReferenceId()
      This unique value is used by the processor to rule out the duplicates

    • getOriginalTransactionId

      public String getOriginalTransactionId()
      The parent PaymentTransactionDetail identifier, typically used in a PaymentAccountProcessingTransactionType.REFUND transaction

    • getBillingAttemptNumber

      public Integer getBillingAttemptNumber()
      The number of the billing attempt that created this transaction. One-based, first one is: 1, second one is: 2 and so on.

    • getWalletLoopThroughNumber

      public Integer getWalletLoopThroughNumber()
      The number of the payment account in the billing attempt. One-based, first one is: 1, second one is: 2 and so on.

    • getAdditionalFields

      public Map<@Size(max=255) String,@Size(max=2000) String> getAdditionalFields()
      Name/Value pairs of additional attributes. For example, can be used to store the payment processor's internal transaction id

    • getVersion

      public Integer getVersion()

    • getFailureType

      public PaymentFailureTypeEnum getFailureType()
      Payment processor failure severity (i.e. hard or soft failure)

    • getTransactionFailureCategory

      public String getTransactionFailureCategory()
      Payment transaction failure category as determined by the payment processor

    • getContextState

      public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware

    • setId

      public void setId(String id)

    • setPaymentAccountId

      public void setPaymentAccountId(String paymentAccountId)
      Reference to the PaymentAccount used for the transaction

    • setPaymentAccountName

      public void setPaymentAccountName(String paymentAccountName)
      Display name of the payment account from the user’s wallet

    • setPaymentAccountType

      public void setPaymentAccountType(String paymentAccountType)
      The type of the payment account from the user’s wallet

    • setPaymentProcessor

      public void setPaymentProcessor(String paymentProcessor)
      Code for the payment processor used for the transaction. Ex: CYBERSOURCE, PAYPAL

    • setBillingEventPaymentId

      public void setBillingEventPaymentId(String billingEventPaymentId)
      Reference to the related BillingEventPayment

    • setTransactionType

      public void setTransactionType(String transactionType)
      Transaction type of the transaction
      See Also:

    • setAmount

      public void setAmount(BigDecimal amount)
      The monetary amount of this transaction

    • setDateProcessed

      public void setDateProcessed(Date dateProcessed)
      The date and time this transaction was sent to the processor

    • setDateRecorded

      public void setDateRecorded(Date dateRecorded)
      The date and time the processor response was recorded

    • setRawResponse

      public void setRawResponse(String rawResponse)
      The raw response from the payment processor

    • setProcessingResult

      public void setProcessingResult(ProcessingResultEnum processingResult)
      Result of this transaction

    • setFailureReason

      public void setFailureReason(String failureReason)
      Reason for the transaction failure if available

    • setTransactionReferenceId

      public void setTransactionReferenceId(String transactionReferenceId)
      This unique value is used by the processor to rule out the duplicates

    • setOriginalTransactionId

      public void setOriginalTransactionId(String originalTransactionId)
      The parent PaymentTransactionDetail identifier, typically used in a PaymentAccountProcessingTransactionType.REFUND transaction

    • setBillingAttemptNumber

      public void setBillingAttemptNumber(Integer billingAttemptNumber)
      The number of the billing attempt that created this transaction. One-based, first one is: 1, second one is: 2 and so on.

    • setWalletLoopThroughNumber

      public void setWalletLoopThroughNumber(Integer walletLoopThroughNumber)
      The number of the payment account in the billing attempt. One-based, first one is: 1, second one is: 2 and so on.

    • setAdditionalFields

      public void setAdditionalFields(Map<@Size(max=255) String,@Size(max=2000) String> additionalFields)
      Name/Value pairs of additional attributes. For example, can be used to store the payment processor's internal transaction id

    • setVersion

      public void setVersion(Integer version)

    • setFailureType

      public void setFailureType(PaymentFailureTypeEnum failureType)
      Payment processor failure severity (i.e. hard or soft failure)

    • setTransactionFailureCategory

      public void setTransactionFailureCategory(String transactionFailureCategory)
      Payment transaction failure category as determined by the payment processor

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware

    • 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