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.
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()
.
-
Constructor Summary
ConstructorDescriptionDeprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
Deprecated, for removal: This API element is subject to removal in a future version.boolean
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.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.Deprecated, for removal: This API element is subject to removal in a future version.The specific card type, i.e.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
Deprecated, for removal: This API element is subject to removal in a future version.A subset ofTracking
information 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 id of 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.The month the payment gateway account associated with this payment account will expire.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.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 transaction successful.Deprecated, for removal: This API element is subject to removal in a future version.Partial information about the payment account, e.g.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.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 number
for this billing address.Deprecated, for removal: This API element is subject to removal in a future version.The secondaryphone number
for 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.int
hashCode()
Deprecated, for removal: This API element is subject to removal in a future version.boolean
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
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 ofTracking
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
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 Paymentvoid
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
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.ThePayment.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 transactionsvoid
setPhonePrimary
(Phone phonePrimary) Deprecated, for removal: This API element is subject to removal in a future version.The primaryphone number
for this billing address.void
setPhoneSecondary
(Phone phoneSecondary) Deprecated, for removal: This API element is subject to removal in a future version.The secondaryphone 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.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
-
setCustomerId
Deprecated, for removal: This API element is subject to removal in a future version. -
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
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
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
-
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
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
-
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
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
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
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
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 number
for this billing address.- Returns:
- The primary
phone number
for this address.
-
getPhoneSecondary
Deprecated, for removal: This API element is subject to removal in a future version.The secondaryphone number
for this billing address.- Returns:
- The secondary
phone number
for 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 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 ofTracking
information to expose the context state for this object.- Specified by:
getContextState
in interfacecom.broadleafcommerce.data.tracking.core.ContextStateAware
- Returns:
- a subset of
Tracking
information 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
-
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 number
for this billing address.- Parameters:
phonePrimary
- The primaryphone number
for this address.
-
setPhoneSecondary
Deprecated, for removal: This API element is subject to removal in a future version.The secondaryphone number
for this billing address.- Parameters:
phoneSecondary
- The secondaryphone number
for 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 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 ofTracking
information to expose the context state for this object.- Specified by:
setContextState
in interfacecom.broadleafcommerce.data.tracking.core.ContextStateAware
- Parameters:
contextState
- a subset ofTracking
information 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.
-
SavedPaymentMethod
to manage saved payment methods.