Package com.broadleafcommerce.payment.service.gateway

Class StoreCreditTransactionExecutionRequest

java.lang.Object
com.broadleafcommerce.payment.service.gateway.StoreCreditTransactionExecutionRequest
All Implemented Interfaces:
Serializable
public class StoreCreditTransactionExecutionRequest extends Object implements Serializable
A request DTO used to execute a CreditAccountTransaction.
Author:
Dima Myroniuk (dmyroniuk)
See Also:

  • Constructor Details

    • StoreCreditTransactionExecutionRequest

      public StoreCreditTransactionExecutionRequest()

  • Method Details

    • getTransactionAmount

      public javax.money.MonetaryAmount getTransactionAmount()
      The transaction amount for this transaction.
      Returns:
      The transaction amount for this transaction.

    • getTransactionReferenceId

      public String getTransactionReferenceId()
      The transaction id known by the payment gateway. This reference can be used to link the request to the gateway's record of the transaction in the case that the calling application does not receive a response from the gateway.
      Returns:
      The transaction id known by the payment gateway

    • getRequestId

      public String getRequestId()
      The id used to represent the request that produced this transaction.
      Returns:
      The id used to represent the request that produced this transaction

    • getSource

      public String getSource()
      The name of the system that initiated the transaction - e.g. CART_OPERATION_SERVICES vs ORDER_OPERATION_SERVICES.
      Returns:
      The name of the system that initiated the transaction

    • getSourceUserType

      public String getSourceUserType()
      The type of user who initiated the transaction. By default, it can be "BLC_CUSTOMER", "BLC_ACCOUNT" or "BLC_CSR".
      Returns:
      The type of user who initiated the transaction

    • getSourceUserId

      public String getSourceUserId()
      The id of user who initiated the transaction.
      Returns:
      The id of user who initiated the transaction

    • getSourceEntityType

      public String getSourceEntityType()
      The type of the source entity associated with the transaction. For example, "CHECKOUT_REQUEST" or "ORDER_FULFILLMENT".
      Returns:
      The type of the source entity associated with the transaction

    • getSourceEntityId

      public String getSourceEntityId()
      The ID of the source entity associated with the transaction.

      For example, if getSourceEntityType() is ORDER_FULFILLMENT, this would be the ID of the OrderFulfillment.

      Returns:
      The ID of the source entity associated with the transaction
      See Also:

    • getReason

      public String getReason()
      The reason for this transaction.
      Returns:
      The reason for this transaction

    • getReasonDescription

      public String getReasonDescription()
      Description for the reason for this transaction.
      Returns:
      Description for the reason for this transaction

    • setTransactionAmount

      public void setTransactionAmount(javax.money.MonetaryAmount transactionAmount)
      The transaction amount for this transaction.
      Parameters:
      transactionAmount - The transaction amount for this transaction

    • setTransactionReferenceId

      public void setTransactionReferenceId(String transactionReferenceId)
      The transaction id known by the payment gateway. This reference can be used to link the request to the gateway's record of the transaction in the case that the calling application does not receive a response from the gateway.
      Parameters:
      transactionReferenceId - The transaction id known by the payment gateway

    • setRequestId

      public void setRequestId(String requestId)
      The id used to represent the request that produced this transaction.
      Parameters:
      requestId - The id used to represent the request that produced this transaction

    • setSource

      public void setSource(String source)
      The name of the system that initiated the transaction - e.g. CART_OPERATION_SERVICES vs ORDER_OPERATION_SERVICES.
      Parameters:
      source - The name of the system that initiated the transaction

    • setSourceUserType

      public void setSourceUserType(String sourceUserType)
      The type of user who initiated the transaction. By default, it can be "BLC_CUSTOMER", "BLC_ACCOUNT" or "BLC_CSR".
      Parameters:
      sourceUserType - The type of user who initiated the transaction

    • setSourceUserId

      public void setSourceUserId(String sourceUserId)
      The id of user who initiated the transaction.
      Parameters:
      sourceUserId - The id of user who initiated the transaction

    • setSourceEntityType

      public void setSourceEntityType(String sourceEntityType)
      The type of the source entity associated with the transaction. For example, "CHECKOUT_REQUEST" or "ORDER_FULFILLMENT".
      Parameters:
      sourceEntityType - The type of the source entity associated with the transaction

    • setSourceEntityId

      public void setSourceEntityId(String sourceEntityId)
      The ID of the source entity associated with the transaction.

      For example, if getSourceEntityType() is ORDER_FULFILLMENT, this would be the ID of the OrderFulfillment.

      Parameters:
      sourceEntityId - The ID of the source entity associated with the transaction
      See Also:

    • setReason

      public void setReason(String reason)
      The reason for this transaction.
      Parameters:
      reason - The reason for this transaction

    • setReasonDescription

      public void setReasonDescription(String reasonDescription)
      Description for the reason for this transaction.
      Parameters:
      reasonDescription - Description for the reason for this transaction

    • 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