Package com.broadleafcommerce.paymenttransaction.service.provider.external.domain

Class PaymentAccount

java.lang.Object
com.broadleafcommerce.paymenttransaction.service.provider.external.domain.PaymentAccount
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
@Deprecated(since="1.0.2", forRemoval=true) public class PaymentAccount extends Object implements Serializable, com.broadleafcommerce.data.tracking.core.ContextStateAware
Deprecated, for removal: This API element is subject to removal in a future version.
since 1.0.2, in favor of using SavedPaymentMethod to manage saved payment methods.
This entity is the Broadleaf CustomerServices representation of saved payment methods, while SavedPaymentMethod is the Broadleaf PaymentTransactionServices representation of saved payment methods.

The representation of saved payment methods can be configured using SavedPaymentMethodConfigurationProperties.getStorageLocation().

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    PaymentAccount()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    equals(Object o)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getAccountType()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This represents the type of payment that is associated with this account.
    String
    getAddressLine1()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Primary address information associated with this payment account, typically street name and building number.
    String
    getAddressLine2()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Secondary address information associated with this payment account, typically apartment, suite, or unit number.
    String
    getAddressLine3()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Tertiary address information associated with this payment account, typically for international addresses.
    String
    getCardType()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The specific card type, i.e.
    String
    getCity()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The city, town or village of this billing address.
    com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState
    getContextState()
    Deprecated, for removal: This API element is subject to removal in a future version.
    A subset of Tracking information to expose the context state for this object.
    String
    getCountry()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The country for this billing address.
    String
    getCounty()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The county of this billing address.
    String
    getCustomerId()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The id of the customer associated with this payment account.
    Map<String,String>
    getDisplayAttributes()
    Deprecated, for removal: This API element is subject to removal in a future version.
    General use map to capture any display properties for the Payment
    String
    getDisplayName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The user-friendly name provided for the payment account.
    Integer
    getExpirationMonth()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The month the payment gateway account associated with this payment account will expire.
    Integer
    getExpirationYear()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The year the payment gateway account associated with this payment account will expire.
    String
    getFullName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The combined names of the individual at this billing address.
    String
    getGatewayType()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The payment gateway associated with this payment account.
    String
    getId()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The context ID of the payment account.
    Instant
    getLastTransactionDateTime()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The timestamp of the last successful transaction made by this payment account.
    String
    getLastTransactionResultCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The result code returned from the gateway on the last transaction successful.
    String
    getMaskedAccountNumber()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Partial information about the payment account, e.g.
    String
    getNameOnAccount()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The name associated with this payment account.
    String
    getOriginatingPaymentId()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The Payment.getId() that this payment account was created from.
    Map<String,String>
    getPaymentGatewayProperties()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Map to capture any gateway-specific information needed to perform gateway transactions
    Phone
    getPhonePrimary()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The primary phone number for this billing address.
    Phone
    getPhoneSecondary()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The secondary phone number for this billing address.
    String
    getPostalCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Postal code or ZIP code for this billing address.
    String
    getStateProvinceRegion()
    Deprecated, for removal: This API element is subject to removal in a future version.
    The state, province or region of this address.
    int
    hashCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isDeactivated()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Whether this account is deactivated.
    void
    setAccountType(String accountType)
    Deprecated, for removal: This API element is subject to removal in a future version.
    This represents the type of payment that is associated with this account.
    void
    setAddressLine1(String addressLine1)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Primary address information associated with this payment account, typically street name and building number.
    void
    setAddressLine2(String addressLine2)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Secondary address information associated with this payment account, typically apartment, suite, or unit number.
    void
    setAddressLine3(String addressLine3)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Tertiary address information associated with this payment account, typically for international addresses.
    void
    setCardType(String cardType)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The specific card type, i.e.
    void
    setCity(String city)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The city, town or village of this billing address.
    void
    setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
    Deprecated, for removal: This API element is subject to removal in a future version.
    A subset of Tracking information to expose the context state for this object.
    void
    setCountry(String country)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The country for this billing address.
    void
    setCounty(String county)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The county of this billing address.
    void
    setCustomerId(Map<String,String> customerRef)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setDeactivated(boolean deactivated)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Whether this account is deactivated.
    void
    setDisplayAttributes(Map<String,String> displayAttributes)
    Deprecated, for removal: This API element is subject to removal in a future version.
    General use map to capture any display properties for the Payment
    void
    setDisplayName(String displayName)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The user-friendly name provided for the payment account.
    void
    setExpirationMonth(Integer expirationMonth)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The month the payment gateway account associated with this payment account will expire.
    void
    setExpirationYear(Integer expirationYear)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The year the payment gateway account associated with this payment account will expire.
    void
    setFullName(String fullName)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The combined names of the individual at this billing address.
    void
    setGatewayType(String gatewayType)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The payment gateway associated with this payment account.
    void
    setId(String id)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The context ID of the payment account.
    void
    setLastTransactionDateTime(Instant lastTransactionDateTime)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The timestamp of the last successful transaction made by this payment account.
    void
    setLastTransactionResultCode(String lastTransactionResultCode)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The result code returned from the gateway on the last transaction successful.
    void
    setMaskedAccountNumber(String maskedAccountNumber)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Partial information about the payment account, e.g.
    void
    setNameOnAccount(String nameOnAccount)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The name associated with this payment account.
    void
    setOriginatingPaymentId(String originatingPaymentId)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The Payment.getId() that this payment account was created from.
    void
    setPaymentGatewayProperties(Map<String,String> paymentGatewayProperties)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Map to capture any gateway-specific information needed to perform gateway transactions
    void
    setPhonePrimary(Phone phonePrimary)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The primary phone number for this billing address.
    void
    setPhoneSecondary(Phone phoneSecondary)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The secondary phone number for this billing address.
    void
    setPostalCode(String postalCode)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Postal code or ZIP code for this billing address.
    void
    setStateProvinceRegion(String stateProvinceRegion)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The state, province or region of this address.
    String
    toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PaymentAccount

      public PaymentAccount()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • setCustomerId

      public void setCustomerId(Map<String,String> customerRef)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getId

      public String getId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The context ID of the payment account.
      Returns:
      the context ID of the payment account

    • getCustomerId

      public String getCustomerId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The id of the customer associated with this payment account.
      Returns:
      the id of the customer linked to the payment account

    • getOriginatingPaymentId

      public String getOriginatingPaymentId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The Payment.getId() that this payment account was created from. This is typically populated when a multi-use payment token is produced by executing a transaction against a single-use token via a checkout interaction.
      Returns:
      The Payment.getId() that this payment account was created from

    • getDisplayName

      public String getDisplayName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The user-friendly name provided for the payment account.
      Returns:
      the display name of the payment account

    • getAccountType

      public String getAccountType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This represents the type of payment that is associated with this account.
      Returns:
      the account type of the payment account

    • getCardType

      public String getCardType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The specific card type, i.e. Visa, Mastercard, Discover, etc.
      Returns:
      the card type of the payment account

    • getGatewayType

      public String getGatewayType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The payment gateway associated with this payment account.
      Returns:
      the payment token gateway associated with the payment account

    • getPaymentGatewayProperties

      public Map<String,String> getPaymentGatewayProperties()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Map to capture any gateway-specific information needed to perform gateway transactions
      Returns:
      Map to capture any gateway-specific information needed to perform gateway transactions

    • getDisplayAttributes

      public Map<String,String> getDisplayAttributes()
      Deprecated, for removal: This API element is subject to removal in a future version.
      General use map to capture any display properties for the Payment
      Returns:
      General use map to capture any display properties for the Payment

    • getMaskedAccountNumber

      public String getMaskedAccountNumber()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Partial information about the payment account, e.g. last four numbers of a credit card.
      Returns:

    • getNameOnAccount

      public String getNameOnAccount()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The name associated with this payment account.
      Returns:
      the name on the payment account

    • getExpirationMonth

      public Integer getExpirationMonth()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The month the payment gateway account associated with this payment account will expire.
      Returns:
      the expiration month of the payment account

    • getExpirationYear

      public Integer getExpirationYear()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The year the payment gateway account associated with this payment account will expire.
      Returns:
      the expiration year of the payment account

    • getFullName

      public String getFullName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The combined names of the individual at this billing address. It is considered better UX to use a full name field in place of separate first and last name fields.
      Returns:
      The combined names of the individual at this address

    • getAddressLine1

      public String getAddressLine1()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Primary address information associated with this payment account, typically street name and building number.
      Returns:
      the first address line for the payment account

    • getAddressLine2

      public String getAddressLine2()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Secondary address information associated with this payment account, typically apartment, suite, or unit number.
      Returns:
      the second address line for the payment account

    • getAddressLine3

      public String getAddressLine3()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Tertiary address information associated with this payment account, typically for international addresses.
      Returns:
      Tertiary address information, typically for international addresses.

    • getCity

      public String getCity()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The city, town or village of this billing address.
      Returns:
      The city, town or village of this address.

    • getCounty

      public String getCounty()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The county of this billing address.
      Returns:
      The county of this address.

    • getStateProvinceRegion

      public String getStateProvinceRegion()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The state, province or region of this address.
      Returns:
      The state, province or region of this address.

    • getCountry

      public String getCountry()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The country for this billing address.
      Returns:
      The country for this address.

    • getPostalCode

      public String getPostalCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Postal code or ZIP code for this billing address.
      Returns:
      Postal code or ZIP code for this address.

    • getPhonePrimary

      public Phone getPhonePrimary()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The primary phone number for this billing address.
      Returns:
      The primary phone number for this address.

    • getPhoneSecondary

      public Phone getPhoneSecondary()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The secondary phone number for this billing address.
      Returns:
      The secondary phone number for this address.

    • getLastTransactionDateTime

      public Instant getLastTransactionDateTime()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The timestamp of the last successful transaction made by this payment account.
      Returns:
      the last successful transaction date and time of the payment account

    • getLastTransactionResultCode

      public String getLastTransactionResultCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      The result code returned from the gateway on the last transaction successful.
      Returns:
      the result code from the last successful transaction for this payment account

    • isDeactivated

      public boolean isDeactivated()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Whether this account is deactivated.
      Returns:
      Whether this account is deactivated.

    • getContextState

      public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
      Deprecated, for removal: This API element is subject to removal in a future version.
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Returns:
      a subset of Tracking information to expose the context state for this object.

    • setId

      public void setId(String id)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The context ID of the payment account.
      Parameters:
      id - the context ID of the payment account

    • setOriginatingPaymentId

      public void setOriginatingPaymentId(String originatingPaymentId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The Payment.getId() that this payment account was created from. This is typically populated when a multi-use payment token is produced by executing a transaction against a single-use token via a checkout interaction.
      Parameters:
      originatingPaymentId - The Payment.getId() that this payment account was created from

    • setDisplayName

      public void setDisplayName(String displayName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The user-friendly name provided for the payment account.
      Parameters:
      displayName - the display name of the payment account

    • setAccountType

      public void setAccountType(String accountType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      This represents the type of payment that is associated with this account.
      Parameters:
      accountType - the account type of the payment account

    • setCardType

      public void setCardType(String cardType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The specific card type, i.e. Visa, Mastercard, Discover, etc.
      Parameters:
      cardType - the card type of the payment account

    • setGatewayType

      public void setGatewayType(String gatewayType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The payment gateway associated with this payment account.
      Parameters:
      gatewayType - the payment token gateway associated with the payment account

    • setPaymentGatewayProperties

      public void setPaymentGatewayProperties(Map<String,String> paymentGatewayProperties)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Map to capture any gateway-specific information needed to perform gateway transactions
      Parameters:
      paymentGatewayProperties - Map to capture any gateway-specific information needed to perform gateway transactions

    • setDisplayAttributes

      public void setDisplayAttributes(Map<String,String> displayAttributes)
      Deprecated, for removal: This API element is subject to removal in a future version.
      General use map to capture any display properties for the Payment
      Parameters:
      displayAttributes - General use map to capture any display properties for the Payment

    • setMaskedAccountNumber

      public void setMaskedAccountNumber(String maskedAccountNumber)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Partial information about the payment account, e.g. last four numbers of a credit card.
      Parameters:
      maskedAccountNumber -

    • setNameOnAccount

      public void setNameOnAccount(String nameOnAccount)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The name associated with this payment account.
      Parameters:
      nameOnAccount - the name on the payment account

    • setExpirationMonth

      public void setExpirationMonth(Integer expirationMonth)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The month the payment gateway account associated with this payment account will expire.
      Parameters:
      expirationMonth - the expiration month of the payment account

    • setExpirationYear

      public void setExpirationYear(Integer expirationYear)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The year the payment gateway account associated with this payment account will expire.
      Parameters:
      expirationYear - the expiration year of the payment account

    • setFullName

      public void setFullName(String fullName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The combined names of the individual at this billing address. It is considered better UX to use a full name field in place of separate first and last name fields.
      Parameters:
      fullName - The combined names of the individual at this address

    • setAddressLine1

      public void setAddressLine1(String addressLine1)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Primary address information associated with this payment account, typically street name and building number.
      Parameters:
      addressLine1 - the first address line for the payment account

    • setAddressLine2

      public void setAddressLine2(String addressLine2)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Secondary address information associated with this payment account, typically apartment, suite, or unit number.
      Parameters:
      addressLine2 - the second address line for the payment account

    • setAddressLine3

      public void setAddressLine3(String addressLine3)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Tertiary address information associated with this payment account, typically for international addresses.
      Parameters:
      addressLine3 - Tertiary address information, typically for international addresses.

    • setCity

      public void setCity(String city)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The city, town or village of this billing address.
      Parameters:
      city - The city, town or village of this address.

    • setCounty

      public void setCounty(String county)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The county of this billing address.
      Parameters:
      county - The county of this address.

    • setStateProvinceRegion

      public void setStateProvinceRegion(String stateProvinceRegion)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The state, province or region of this address.
      Parameters:
      stateProvinceRegion - The state, province or region of this address.

    • setCountry

      public void setCountry(String country)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The country for this billing address.
      Parameters:
      country - The country for this address.

    • setPostalCode

      public void setPostalCode(String postalCode)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Postal code or ZIP code for this billing address.
      Parameters:
      postalCode - Postal code or ZIP code for this address.

    • setPhonePrimary

      public void setPhonePrimary(Phone phonePrimary)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The primary phone number for this billing address.
      Parameters:
      phonePrimary - The primary phone number for this address.

    • setPhoneSecondary

      public void setPhoneSecondary(Phone phoneSecondary)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The secondary phone number for this billing address.
      Parameters:
      phoneSecondary - The secondary phone number for this address.

    • setLastTransactionDateTime

      public void setLastTransactionDateTime(Instant lastTransactionDateTime)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The timestamp of the last successful transaction made by this payment account.
      Parameters:
      lastTransactionDateTime - the last successful transaction date and time of the payment account

    • setLastTransactionResultCode

      public void setLastTransactionResultCode(String lastTransactionResultCode)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The result code returned from the gateway on the last transaction successful.
      Parameters:
      lastTransactionResultCode - the result code from the last successful transaction for this payment account account

    • setDeactivated

      public void setDeactivated(boolean deactivated)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Whether this account is deactivated.
      Parameters:
      deactivated - Whether this account is deactivated.

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
      Deprecated, for removal: This API element is subject to removal in a future version.
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Parameters:
      contextState - a subset of Tracking information to expose the context state for this object

    • equals

      public boolean equals(Object o)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • hashCode

      public int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class Object