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

Class CreateSavedPaymentMethodRequest

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

  • Constructor Details

    • CreateSavedPaymentMethodRequest

      public CreateSavedPaymentMethodRequest()

  • Method Details

    • getName

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

    • isDefaultForOwner

      public boolean isDefaultForOwner()
      Whether this saved payment method is the default payment method for the owner entity.
      Returns:
      True if this saved payment method is the default payment method for the owner, otherwise false.

    • getOwningUserType

      public String getOwningUserType()
      Describes the owning user of the saved payment method. For example, the saved payment could belong to a Broadleaf customer or an account, therefore this value might be BLC_CUSTOMER, or BLC_ACCOUNT.
      Returns:
      The type describing the owning user of the saved payment method
      See Also:

    • getOwningUserId

      public String getOwningUserId()
      The id of the entity that owns this saved payment method. For example, this may be a customer id, or an account id.
      Returns:
      The id of the entity that owns this saved payment method.

    • getType

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

    • getGatewayType

      public String getGatewayType()
      The gateway used to process this saved payment method. Only a SINGLE payment gateway can modify transactions on a particular payment.
      Returns:
      The gateway used to process this saved payment method.
      See Also:
      • PaymentGatewayType

    • 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

    • 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

    • getDisplayAttributes

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

    • getBillingAddress

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

    • getVisibleToChildren

      public String getVisibleToChildren()
      The visibility of the payment method to child accounts
      Returns:
      The visibility of the payment method to child accounts

    • getGatewayReferenceId

      @Nullable public String getGatewayReferenceId()
      See Also:

    • getNextAction

      @Nullable public SavedPaymentMethodNextAction getNextAction()
      See Also:

    • setName

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

    • setDefaultForOwner

      public void setDefaultForOwner(boolean defaultForOwner)
      Whether this saved payment method is the default payment method for the owner entity.
      Parameters:
      name - Whether this saved payment method is the default payment method for the owner entity.

    • setOwningUserType

      public void setOwningUserType(String owningUserType)
      Describes the owning user of the saved payment method. For example, the saved payment could belong to a Broadleaf customer or an account, therefore this value might be BLC_CUSTOMER, or BLC_ACCOUNT.
      Parameters:
      owningUserType - The type describing the owning user of the saved payment method
      See Also:

    • setOwningUserId

      public void setOwningUserId(String owningUserId)
      The id of the entity that owns this saved payment method. For example, this may be a customer id, or an account id.
      Parameters:
      owningUserId - The id of the entity that owns this saved payment method.

    • setType

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

    • setGatewayType

      public void setGatewayType(String gatewayType)
      The gateway used to process this saved payment method. Only a SINGLE payment gateway can modify transactions on a particular payment.
      Parameters:
      gatewayType - The gateway used to process this saved payment method.
      See Also:
      • PaymentGatewayType

    • 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

    • 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

    • setDisplayAttributes

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

    • setBillingAddress

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

    • setVisibleToChildren

      public void setVisibleToChildren(String visibleToChildren)
      The visibility of the payment method to child accounts
      Parameters:
      visibleToChildren - The visibility of the payment method to child accounts

    • setGatewayReferenceId

      public void setGatewayReferenceId(@Nullable String gatewayReferenceId)
      See Also:

    • setNextAction

      public void setNextAction(@Nullable SavedPaymentMethodNextAction nextAction)
      See Also:

    • 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