Class PaymentAccount
java.lang.Object
com.broadleafcommerce.customer.domain.PaymentAccount
- All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware,com.broadleafcommerce.data.tracking.core.policy.Owned,Serializable
@Deprecated(since="1.7.2",
forRemoval=true)
public class PaymentAccount
extends Object
implements Serializable, com.broadleafcommerce.data.tracking.core.ContextStateAware, com.broadleafcommerce.data.tracking.core.policy.Owned
Deprecated, for removal: This API element is subject to removal in a future version.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionDeprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanDeprecated, for removal: This API element is subject to removal in a future version.booleanDeprecated, for removal: This API element is subject to removal in a future version.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.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.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.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.protected StringDeprecated, for removal: This API element is subject to removal in a future version.Gets the attribute name to retrieve the card expiration month fromPayment.getDisplayAttributes().protected StringDeprecated, for removal: This API element is subject to removal in a future version.Gets the attribute name to retrieve the card expiration year fromPayment.getDisplayAttributes().protected StringDeprecated, for removal: This API element is subject to removal in a future version.Gets the attribute name to retrieve the card number fromPayment.getDisplayAttributes().Deprecated, for removal: This API element is subject to removal in a future version.protected StringDeprecated, for removal: This API element is subject to removal in a future version.Gets the attribute name to retrieve the card type fromPayment.getDisplayAttributes().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.ContextStateDeprecated, for removal: This API element is subject to removal in a future version.A subset ofTrackinginformation to expose the context state for this object.Deprecated, for removal: This API element is subject to removal in a future version.The country for this billing address.Deprecated, for removal: This API element is subject to removal in a future version.The county of this billing address.Deprecated, for removal: This API element is subject to removal in a future version.The customer associated with this payment account.Deprecated, for removal: This API element is subject to removal in a future version.General use map to capture any display properties for the PaymentDeprecated, for removal: This API element is subject to removal in a future version.The user-friendly name provided for the payment account.Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.The combined names of the individual at this billing address.Deprecated, for removal: This API element is subject to removal in a future version.The payment gateway associated with this payment account.getId()Deprecated, for removal: This API element is subject to removal in a future version.The context ID of the payment account.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.Deprecated, for removal: This API element is subject to removal in a future version.The result code returned from the gateway on the last successful transaction.Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.The name associated with this payment account.Deprecated, for removal: This API element is subject to removal in a future version.ThePayment.getId()that this payment account was created from.Deprecated, for removal: This API element is subject to removal in a future version.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 transactionsDeprecated, for removal: This API element is subject to removal in a future version.The primaryphone numberfor this billing address.Deprecated, for removal: This API element is subject to removal in a future version.The secondaryphone numberfor this billing address.Deprecated, for removal: This API element is subject to removal in a future version.Postal code or ZIP code for this billing address.Deprecated, for removal: This API element is subject to removal in a future version.The state, province or region of this address.inthashCode()Deprecated, for removal: This API element is subject to removal in a future version.booleanDeprecated, for removal: This API element is subject to removal in a future version.Whether this account is deactivated.voidsetAccountType(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.voidsetAddressLine1(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.voidsetAddressLine2(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.voidsetAddressLine3(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.voidsetCardType(String cardType) Deprecated, for removal: This API element is subject to removal in a future version.The specific card type, i.e.voidDeprecated, for removal: This API element is subject to removal in a future version.The city, town or village of this billing address.voidsetContextState(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 ofTrackinginformation to expose the context state for this object.voidsetCountry(String country) Deprecated, for removal: This API element is subject to removal in a future version.The country for this billing address.voidDeprecated, for removal: This API element is subject to removal in a future version.The county of this billing address.voidsetCustomerRef(CustomerRef customerRef) Deprecated, for removal: This API element is subject to removal in a future version.The customer associated with this payment account.voidsetDeactivated(boolean deactivated) Deprecated, for removal: This API element is subject to removal in a future version.Whether this account is deactivated.voidsetDisplayAttributes(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 PaymentvoidsetDisplayName(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.voidsetExpirationMonth(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.voidsetExpirationYear(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.voidsetFullName(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.voidsetGatewayType(String gatewayType) Deprecated, for removal: This API element is subject to removal in a future version.The payment gateway associated with this payment account.voidDeprecated, for removal: This API element is subject to removal in a future version.The context ID of the payment account.voidsetLastTransactionDateTime(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.voidsetLastTransactionResultCode(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 successful transaction.voidsetMaskedAccountNumber(String maskedAccountNumber) Deprecated, for removal: This API element is subject to removal in a future version.Partial information about the payment account, e.g.voidsetNameOnAccount(String nameOnAccount) Deprecated, for removal: This API element is subject to removal in a future version.The name associated with this payment account.voidsetOriginatingPaymentId(String originatingPaymentId) Deprecated, for removal: This API element is subject to removal in a future version.ThePayment.getId()that this payment account was created from.voidsetPaymentGatewayProperties(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 transactionsvoidsetPhonePrimary(Phone phonePrimary) Deprecated, for removal: This API element is subject to removal in a future version.The primaryphone numberfor this billing address.voidsetPhoneSecondary(Phone phoneSecondary) Deprecated, for removal: This API element is subject to removal in a future version.The secondaryphone numberfor this billing address.voidsetPostalCode(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.voidsetStateProvinceRegion(String stateProvinceRegion) Deprecated, for removal: This API element is subject to removal in a future version.The state, province or region of this address.toString()Deprecated, for removal: This API element is subject to removal in a future version.
-
Constructor Details
-
PaymentAccount
public PaymentAccount()Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Method Details
-
getCardType
Deprecated, for removal: This API element is subject to removal in a future version. -
getMaskedAccountNumber
Deprecated, for removal: This API element is subject to removal in a future version. -
getExpirationMonth
Deprecated, for removal: This API element is subject to removal in a future version. -
getExpirationYear
Deprecated, for removal: This API element is subject to removal in a future version. -
getCardTypeAttributeName
Deprecated, for removal: This API element is subject to removal in a future version.Gets the attribute name to retrieve the card type fromPayment.getDisplayAttributes().- Returns:
- the attribute name to retrieve the card type from
Payment.getDisplayAttributes().
-
getCardNumberAttributeName
Deprecated, for removal: This API element is subject to removal in a future version.Gets the attribute name to retrieve the card number fromPayment.getDisplayAttributes().- Returns:
- the attribute name to retrieve the card number from
Payment.getDisplayAttributes().
-
getCardExpirationMonthAttributeName
Deprecated, for removal: This API element is subject to removal in a future version.Gets the attribute name to retrieve the card expiration month fromPayment.getDisplayAttributes().- Returns:
- the attribute name to retrieve the card expiration month from
Payment.getDisplayAttributes().
-
getCardExpirationYearAttributeName
Deprecated, for removal: This API element is subject to removal in a future version.Gets the attribute name to retrieve the card expiration year fromPayment.getDisplayAttributes().- Returns:
- the attribute name to retrieve the card expiration year from
Payment.getDisplayAttributes().
-
getOwnerIdentifier
Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
getOwnerIdentifierin interfacecom.broadleafcommerce.data.tracking.core.policy.Owned
-
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
-
getCustomerRef
Deprecated, for removal: This API element is subject to removal in a future version.The customer associated with this payment account.- Returns:
- the customer linked to the payment account
-
getOriginatingPaymentId
Deprecated, for removal: This API element is subject to removal in a future version.ThePayment.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
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
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
-
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
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
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
-
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
-
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
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
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
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
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
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
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
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
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
Deprecated, for removal: This API element is subject to removal in a future version.The primaryphone numberfor this billing address.- Returns:
- The primary
phone numberfor this address.
-
getPhoneSecondary
Deprecated, for removal: This API element is subject to removal in a future version.The secondaryphone numberfor this billing address.- Returns:
- The secondary
phone numberfor this address.
-
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
Deprecated, for removal: This API element is subject to removal in a future version.The result code returned from the gateway on the last successful transaction.- 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 ofTrackinginformation to expose the context state for this object.- Specified by:
getContextStatein interfacecom.broadleafcommerce.data.tracking.core.ContextStateAware- Returns:
- a subset of
Trackinginformation to expose the context state for this object.
-
setId
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
-
setCustomerRef
Deprecated, for removal: This API element is subject to removal in a future version.The customer associated with this payment account.- Parameters:
customerRef- the customer linked to the payment account
-
setOriginatingPaymentId
Deprecated, for removal: This API element is subject to removal in a future version.ThePayment.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- ThePayment.getId()that this payment account was created from
-
setDisplayName
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Deprecated, for removal: This API element is subject to removal in a future version.The primaryphone numberfor this billing address.- Parameters:
phonePrimary- The primaryphone numberfor this address.
-
setPhoneSecondary
Deprecated, for removal: This API element is subject to removal in a future version.The secondaryphone numberfor this billing address.- Parameters:
phoneSecondary- The secondaryphone numberfor this address.
-
setLastTransactionDateTime
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
Deprecated, for removal: This API element is subject to removal in a future version.The result code returned from the gateway on the last successful transaction.- 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 ofTrackinginformation to expose the context state for this object.- Specified by:
setContextStatein interfacecom.broadleafcommerce.data.tracking.core.ContextStateAware- Parameters:
contextState- a subset ofTrackinginformation to expose the context state for this object
-
equals
Deprecated, for removal: This API element is subject to removal in a future version. -
canEqual
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. -
toString
Deprecated, for removal: This API element is subject to removal in a future version.
-
SavedPaymentMethodin PaymentTransactionServices to manage saved payment methods.