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

Class CreatePaymentRequest

java.lang.Object
com.broadleafcommerce.paymenttransaction.web.endpoint.domain.CreatePaymentRequest
All Implemented Interfaces:
Serializable
public class CreatePaymentRequest extends Object implements Serializable
A request DTO used to create a Payment.
Author:
Chad Harchar (charchar), Chris Kittrell (ckittrell)
See Also:

  • Constructor Details

    • CreatePaymentRequest

      public CreatePaymentRequest()

  • Method Details

    • shouldSavePaymentToCustomer

      @Deprecated(since="1.0.2", forRemoval=true) public boolean shouldSavePaymentToCustomer()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1.0.2, in favor of shouldSavePaymentForFutureUse() 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

    • getOwnerType

      public String 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

      public String 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

      public String getOwningUserType()
      Describes the owning user type of the payment. For example, the payment could belong to a customer or an account, therefore this value might be BLC_CUSTOMER or BLC_ACCOUNT.

      This is typically specified for system-initiated actions where the current authentication is not the same as the owning user's context. For example, if the subscription service needs to create a payment for a new billing cycle, the authentication context is the system itself instead of the customer context that actually owns this payment.

      This value is ignored if the owning user type can be resolved based on the current authentication.

      Returns:
      The type describing the owning user of the payment
      See Also:

    • getOwningUserId

      public String getOwningUserId()
      The id of the owning user that owns this payment. For example, this may be a customer id, or an account id.

      This is typically specified for system-initiated actions where the current authentication is not the same as the owning user's context. For example, if the subscription service needs to create a payment for a new billing cycle, the authentication context is the system itself instead of the customer context that actually owns this payment.

      This value is ignored if the owning user id can be resolved based on the current authentication.

      Returns:
      The id of the owning user that owns this payment.

    • getOwningUserName

      public String getOwningUserName()
      The name of the owning user identified by owningUserType and owningUserId.
      Returns:
      The name of the owning user.

    • getOwningUserEmailAddress

      public String getOwningUserEmailAddress()
      The email address of the owning user identified by owningUserType and owningUserId.
      Returns:
      The email address of the owning user.

    • getName

      public String getName()
      The name of this payment. This name is typically something like "Visa ending in 1234".
      Returns:
      The name of this payment.

    • getSavedPaymentMethodId

      public String getSavedPaymentMethodId()
      The id of the saved payment method that was used to build this payment object. Note: This property is only relevant if the user desires to use a saved payment method to pay for their order. Otherwise, this value should remain unset.
      Returns:
      The id of the saved payment method.

    • 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

    • getType

      public String getType()
      The type of this payment like Credit Card or Gift Card.
      Returns:
      The type of this payment like Credit Card or Gift Card.
      See Also:
      • DefaultPaymentTypes

    • getGatewayType

      public String 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.
      See Also:
      • PaymentGatewayType

    • 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 the amount is required, but if this value is included, then the fulfillmentTotal, 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 the amount is required, but if this value is included, then the subtotal, 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 the amount is required, but if this value is included, then the subtotal, 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 transaction amount Note: Only the amount is required, but if this value is included, then the subtotal, 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 the amount is required, but if this value is included, then the subtotal, 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 the amount is required, but if this value is included, then the subtotal, fulfillmentTotal, feesTotal, adjustmentsTotal, & taxTotal should be included also.
      Returns:
      The amount of taxes that are included in the subtotal (VAT).

    • getShippingAddress

      public Address getShippingAddress()
      The shipping address associated with this payment.
      Returns:
      The shipping address associated with this payment.

    • getBillingAddress

      public Address getBillingAddress()
      The billing address associated with this payment.
      Returns:
      The billing address associated with this payment.

    • getPaymentMethodProperties

      public Map<String,String> 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

    • getDisplayAttributes

      public Map<String,String> getDisplayAttributes()
      General use map to capture any display properties for this Payment
      Returns:
      General use map to capture any display properties for this Payment

    • getAttributes

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

    • setOwnerType

      public void setOwnerType(String ownerType)
      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

      public void setOwnerId(String ownerId)
      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

      public void setOwningUserType(String owningUserType)
      Describes the owning user type of the payment. For example, the payment could belong to a customer or an account, therefore this value might be BLC_CUSTOMER or BLC_ACCOUNT.

      This is typically specified for system-initiated actions where the current authentication is not the same as the owning user's context. For example, if the subscription service needs to create a payment for a new billing cycle, the authentication context is the system itself instead of the customer context that actually owns this payment.

      This value is ignored if the owning user type can be resolved based on the current authentication.

      Parameters:
      owningUserType - The type describing the owning user of the payment
      See Also:

    • setOwningUserId

      public void setOwningUserId(String owningUserId)
      The id of the owning user that owns this payment. For example, this may be a customer id, or an account id.

      This is typically specified for system-initiated actions where the current authentication is not the same as the owning user's context. For example, if the subscription service needs to create a payment for a new billing cycle, the authentication context is the system itself instead of the customer context that actually owns this payment.

      This value is ignored if the owning user id can be resolved based on the current authentication.

      Parameters:
      owningUserId - The id of the owning user that owns this payment.

    • setOwningUserName

      public void setOwningUserName(String owningUserName)
      The name of the owning user identified by owningUserType and owningUserId.
      Parameters:
      owningUserName - The name of the owning user.

    • setOwningUserEmailAddress

      public void setOwningUserEmailAddress(String owningUserEmailAddress)
      The email address of the owning user identified by owningUserType and owningUserId.
      Parameters:
      owningUserEmailAddress - The email address of the owning user.

    • setName

      public void setName(String name)
      The name of this payment. This name is typically something like "Visa ending in 1234".
      Parameters:
      name - The name of this payment.

    • setSavedPaymentMethodId

      public void setSavedPaymentMethodId(String savedPaymentMethodId)
      The id of the saved payment method that was used to build this payment object. Note: This property is only relevant if the user desires to use a saved payment method to pay for their order. Otherwise, this value should remain unset.
      Parameters:
      savedPaymentMethodId - The id of the saved payment method.

    • setSingleUsePaymentMethod

      public void setSingleUsePaymentMethod(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.
      Parameters:
      isSingleUsePaymentMethod - Whether or not the underlying payment method can only be used once

    • setShouldSavePaymentToCustomer

      @Deprecated public void setShouldSavePaymentToCustomer(boolean shouldSavePaymentToCustomer)
      Deprecated.
      since 1.0.2, in favor of shouldSavePaymentForFutureUse 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. Typically, this value is set to true when the payment's initial transaction is executed using a single-use token, and produces a mutli-use token that can be used for future purchases.
      Parameters:
      shouldSavePaymentForFutureUse - Should the payment method be saved to the owning user

    • setType

      public void setType(String type)
      The type of this payment like Credit Card or Gift Card.
      Parameters:
      type - The type of this payment like Credit Card or Gift Card.
      See Also:
      • DefaultPaymentTypes

    • setGatewayType

      public void setGatewayType(String gatewayType)
      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.
      See Also:
      • PaymentGatewayType

    • 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 the amount is required, but if this value is included, then the fulfillmentTotal, 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 the amount is required, but if this value is included, then the subtotal, 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 the amount is required, but if this value is included, then the subtotal, 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 transaction amount Note: Only the amount is required, but if this value is included, then the subtotal, fulfillmentTotal, adjustmentsTotal, taxTotal, & includedTaxTotal should be included also.
      Parameters:
      feesTotal - The total fees related to the transaction amount

    • setTaxTotal

      public void setTaxTotal(javax.money.MonetaryAmount taxTotal)
      The payment's total tax cost. Note: Only the amount is required, but if this value is included, then the subtotal, 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 the amount is required, but if this value is included, then the subtotal, fulfillmentTotal, feesTotal, adjustmentsTotal, & taxTotal should be included also.
      Parameters:
      includedTaxTotal - The amount of taxes that are included in the subtotal (VAT).

    • setShippingAddress

      public void setShippingAddress(Address shippingAddress)
      The shipping address associated with this payment.
      Parameters:
      shippingAddress - The shipping address associated with this payment.

    • setBillingAddress

      public void setBillingAddress(Address billingAddress)
      The billing address associated with this payment.
      Parameters:
      billingAddress - The billing address associated with this payment.

    • setPaymentMethodProperties

      public void setPaymentMethodProperties(Map<String,String> paymentMethodProperties)
      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

    • setDisplayAttributes

      public void setDisplayAttributes(Map<String,String> displayAttributes)
      General use map to capture any display properties for this Payment
      Parameters:
      displayAttributes - General use map to capture any display properties for this Payment

    • setAttributes

      public void setAttributes(Map<String,String> attributes)
      Map to capture any additional information about the payment
      Parameters:
      attributes - 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