Payment (Broadleaf Order Common 1.4.0-GA API)

java.lang.Object
- com.broadleafcommerce.order.common.domain.Payment

All Implemented Interfaces:

Serializable
```
public class Payment
extends Object
implements Serializable
```
This entity is designed to store payment methods associated to a Cart, the getAmount() the user is to be charged via that payment method, and the history of attempted transactions (authorizations, charges, refunds, etc.) against that payment method for the owning Cart. Every payment gateway interaction should have its results stored in the transactions collection.

Payments are not actually deleted from the database but rather are only soft-deleted (archived = true)

Author:

Chad Harchar (charchar), Chris Kittrell (ckittrell)

See Also:

PaymentTransaction, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Payment()

Constructors
Constructor and Description
`Payment()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`javax.money.MonetaryAmount`	`getAdjustmentsTotal()` The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
`javax.money.MonetaryAmount`	`getAmount()` The amount for which this payment is allotted.
`Map<String,String>`	`getAttributes()` General use map to capture any additional attributes needed for this Payment
`Address`	`getBillingAddress()` The billing address associated with this payment.
`String`	`getCustomerPaymentAccountId()` The id of the customer's saved payment account that was used to build this payment object.
`Map<String,String>`	`getDisplayAttributes()` General use map to capture any display properties for this Payment
`javax.money.MonetaryAmount`	`getFulfillmentTotal()` The payment's total fulfillment cost
`String`	`getGatewayType()` The gateway used to process this payment.
`String`	`getId()` The id of this payment.
`String`	`getName()` The name of this payment.
`Map<String,String>`	`getPaymentGatewayProperties()` Map to capture any gateway-specific information needed to perform gateway transactions
`boolean`	`getShouldSavePaymentToCustomer()` Should the payment method be saved to the customer
`String`	`getStatus()` Deprecated. in favor of `PaymentSummary`
`javax.money.MonetaryAmount`	`getSubtotal()` The payment's total usually excluding adjustments, tax, and shipping.
`javax.money.MonetaryAmount`	`getTaxTotal()` The payment's total tax cost
`List<PaymentTransaction>`	`getTransactions()` Transaction data representing each payment gateway interaction related to this payment.
`String`	`getType()` The type of this payment like Credit Card or Gift Card.
`int`	`hashCode()`
`boolean`	`isArchived()` Whether or not this payment has been archived.
`boolean`	`isSingleUsePaymentMethod()` Whether or not the underlying payment method can only be used once.
`void`	`setAdjustmentsTotal(javax.money.MonetaryAmount adjustmentsTotal)` The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
`void`	`setAmount(javax.money.MonetaryAmount amount)` The amount for which this payment is allotted.
`void`	`setArchived(boolean archived)` Whether or not this payment has been archived.
`void`	`setAttributes(Map<String,String> attributes)` General use map to capture any additional attributes needed for this Payment
`void`	`setBillingAddress(Address billingAddress)` The billing address associated with this payment.
`void`	`setCustomerPaymentAccountId(String customerPaymentAccountId)` The id of the customer's saved payment account that was used to build this payment object.
`void`	`setDisplayAttributes(Map<String,String> displayAttributes)` General use map to capture any display properties for this Payment
`void`	`setFulfillmentTotal(javax.money.MonetaryAmount fulfillmentTotal)` The payment's total fulfillment cost
`void`	`setGatewayType(String gatewayType)` The gateway used to process this payment.
`void`	`setId(String id)` The id of this payment.
`void`	`setName(String name)` The name of this payment.
`void`	`setPaymentGatewayProperties(Map<String,String> paymentGatewayProperties)` Map to capture any gateway-specific information needed to perform gateway transactions
`void`	`setShouldSavePaymentToCustomer(boolean shouldSavePaymentToCustomer)` Should the payment method be saved to the customer
`void`	`setSingleUsePaymentMethod(boolean isSingleUsePaymentMethod)` Whether or not the underlying payment method can only be used once.
`void`	`setStatus(String status)` Deprecated. in favor of `PaymentSummary`
`void`	`setSubtotal(javax.money.MonetaryAmount subtotal)` The payment's total usually excluding adjustments, tax, and shipping.
`void`	`setTaxTotal(javax.money.MonetaryAmount taxTotal)` The payment's total tax cost
`void`	`setTransactions(List<PaymentTransaction> transactions)` Transaction data representing each payment gateway interaction related to this payment.
`void`	`setType(String type)` The type of this payment like Credit Card or Gift Card.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Payment
```
public Payment()
```
- Method Detail
  - getShouldSavePaymentToCustomer
```
public boolean getShouldSavePaymentToCustomer()
```
    Should the payment method be saved to the customer
    
    Returns:
    
    Should the payment method be saved to the customer
  - getId
```
public String getId()
```
    The id of this payment.
    
    Returns:
    
    The id of this payment.
  - getName
```
public String getName()
```
    The name of this payment. This name is typically something like "Visa ending in 1234".
    
    Returns:
    
    The name of this payment.
  - getCustomerPaymentAccountId
```
public String getCustomerPaymentAccountId()
```
    The id of the customer's saved payment account that was used to build this payment object. Note: This property is only relevant if the user desires to use a saved payment account to pay for their order. Otherwise, this value should remain unset.
    
    Returns:
    
    The id of the customer's saved payment account.
  - isSingleUsePaymentMethod
```
public boolean isSingleUsePaymentMethod()
```
    Whether or not the underlying payment method can only be used once. In most cases, we're managing a single-use token that represents a credit card. This flag is especially important for managing payments with successful transactions. In those cases, the token has already been used and cannot be reused. If we need modify the payment's amount, then we may actually need to archive the existing payment, and create a new payment, with a new underlying token. Additionally, this flag is helpful when needing to re-authorize an expired authorization transaction. In that case, if the payment represents a single-use payment method, then the re-authorization may not be possible, and you'll need to seek an alternative form of payment.
    
    Returns:
    
    Whether or not the underlying payment method can only be used once
  - getStatus
```
@Deprecated
public String getStatus()
```
    Deprecated. in favor of PaymentSummary
    
    The status of the payment. This status is not populated by default or persisted- it is determined during runtime based on the statuses of the transactions of this payment.
    
    Returns:
    
    the status of the payment.
  - getType
```
public String getType()
```
    The type of this payment like Credit Card or Gift Card.
    
    Returns:
    
    The type of this payment like Credit Card or Gift Card.
  - getGatewayType
```
public String getGatewayType()
```
    The gateway used to process this payment. Only a SINGLE payment gateway can modify transactions on a particular payment.
    
    Returns:
    
    The gateway used to process this payment.
  - getAmount
```
public javax.money.MonetaryAmount getAmount()
```
    The amount for which this payment is allotted. The summation of all of the payments for a particular cart should equal the cart's total. If specified, the amount details (subtotal, adjustmentsTotal, fulfillmentTotal, & taxTotal) should sum together to equal this amount.
    
    Returns:
    
    The amount for which this payment is allotted.
  - getSubtotal
```
public javax.money.MonetaryAmount getSubtotal()
```
    The payment's total usually excluding adjustments, tax, and shipping.
    
    Returns:
    
    The payment's total usually excluding adjustments, tax, and shipping.
  - getAdjustmentsTotal
```
public javax.money.MonetaryAmount getAdjustmentsTotal()
```
    The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
    
    Returns:
    
    The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
  - getFulfillmentTotal
```
public javax.money.MonetaryAmount getFulfillmentTotal()
```
    The payment's total fulfillment cost
    
    Returns:
    
    The payment's total fulfillment cost
  - getTaxTotal
```
public javax.money.MonetaryAmount getTaxTotal()
```
    The payment's total tax cost
    
    Returns:
    
    The payment's total tax cost
  - getBillingAddress
```
public Address getBillingAddress()
```
    The billing address associated with this payment.
    
    Returns:
    
    The billing address associated with this payment.
  - getPaymentGatewayProperties
```
public Map<String,String> getPaymentGatewayProperties()
```
    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
  - getAttributes
```
public Map<String,String> getAttributes()
```
    General use map to capture any additional attributes needed for this Payment
    
    Returns:
    
    General use map to capture any additional attributes needed for this Payment
  - getDisplayAttributes
```
public Map<String,String> getDisplayAttributes()
```
    General use map to capture any display properties for this Payment
    
    Returns:
    
    General use map to capture any display properties for this Payment
  - getTransactions
```
public List<PaymentTransaction> getTransactions()
```
    Transaction data representing each payment gateway interaction related to this payment.
    
    Returns:
    
    Transactions related to this payment.
  - isArchived
```
public boolean isArchived()
```
    Whether or not this payment has been archived.
  - setId
```
public void setId(String id)
```
    The id of this payment.
    
    Parameters:
    
    id - The id of this payment.
  - setName
```
public void setName(String name)
```
    The name of this payment. This name is typically something like "Visa ending in 1234".
    
    Parameters:
    
    name - The name of this payment.
  - setCustomerPaymentAccountId
```
public void setCustomerPaymentAccountId(String customerPaymentAccountId)
```
    The id of the customer's saved payment account that was used to build this payment object. Note: This property is only relevant if the user desires to use a saved payment account to pay for their order. Otherwise, this value should remain unset.
    
    Parameters:
    
    customerPaymentAccountId - The id of the customer's saved payment account.
  - setSingleUsePaymentMethod
```
public void setSingleUsePaymentMethod(boolean isSingleUsePaymentMethod)
```
    Whether or not the underlying payment method can only be used once. In most cases, we're managing a single-use token that represents a credit card. This flag is especially important for managing payments with successful transactions. In those cases, the token has already been used and cannot be reused. If we need modify the payment's amount, then we may actually need to archive the existing payment, and create a new payment, with a new underlying token. Additionally, this flag is helpful when needing to re-authorize an expired authorization transaction. In that case, if the payment represents a single-use payment method, then the re-authorization may not be possible, and you'll need to seek an alternative form of payment.
    
    Parameters:
    
    shouldSavePaymentToCustomer - Whether or not the underlying payment method can only be used once
  - setShouldSavePaymentToCustomer
```
public void setShouldSavePaymentToCustomer(boolean shouldSavePaymentToCustomer)
```
    Should the payment method be saved to the customer
    
    Parameters:
    
    shouldSavePaymentToCustomer - Should the payment method be saved to the customer
  - setStatus
```
@Deprecated
public void setStatus(String status)
```
    Deprecated. in favor of PaymentSummary
    
    The status of the payment. This status is not populated by default or persisted- it is determined during runtime based on the statuses of the transactions of this payment.
    
    Parameters:
    
    status - the status of the payment.
  - setType
```
public void setType(String type)
```
    The type of this payment like Credit Card or Gift Card.
    
    Parameters:
    
    type - The type of this payment like Credit Card or Gift Card.
  - setGatewayType
```
public void setGatewayType(String gatewayType)
```
    The gateway used to process this payment. Only a SINGLE payment gateway can modify transactions on a particular payment.
    
    Parameters:
    
    gatewayType - The gateway used to process this payment.
  - setAmount
```
public void setAmount(javax.money.MonetaryAmount amount)
```
    The amount for which this payment is allotted. The summation of all of the payments for a particular cart should equal the cart's total. If specified, the amount details (subtotal, adjustmentsTotal, fulfillmentTotal, & taxTotal) should sum together to equal this amount.
    
    Parameters:
    
    amount - The amount for which this payment is allotted.
  - setSubtotal
```
public void setSubtotal(javax.money.MonetaryAmount subtotal)
```
    The payment's total usually excluding adjustments, tax, and shipping.
  - setAdjustmentsTotal
```
public void setAdjustmentsTotal(javax.money.MonetaryAmount adjustmentsTotal)
```
    The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
  - setFulfillmentTotal
```
public void setFulfillmentTotal(javax.money.MonetaryAmount fulfillmentTotal)
```
    The payment's total fulfillment cost
  - setTaxTotal
```
public void setTaxTotal(javax.money.MonetaryAmount taxTotal)
```
    The payment's total tax cost
  - setBillingAddress
```
public void setBillingAddress(Address billingAddress)
```
    The billing address associated with this payment.
    
    Parameters:
    
    billingAddress - The billing address associated with this payment.
  - setPaymentGatewayProperties
```
public void setPaymentGatewayProperties(Map<String,String> paymentGatewayProperties)
```
    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
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    General use map to capture any additional attributes needed for this Payment
    
    Parameters:
    
    attributes - General use map to capture any additional attributes needed for this Payment
  - setDisplayAttributes
```
public void setDisplayAttributes(Map<String,String> displayAttributes)
```
    General use map to capture any display properties for this Payment
    
    Parameters:
    
    displayAttributes - General use map to capture any display properties for this Payment
  - setTransactions
```
public void setTransactions(List<PaymentTransaction> transactions)
```
    Transaction data representing each payment gateway interaction related to this payment.
    
    Parameters:
    
    transactions - Transactions related to this payment.
  - setArchived
```
public void setArchived(boolean archived)
```
    Whether or not this payment has been archived.
  - 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

Class Payment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Payment

Method Detail

getShouldSavePaymentToCustomer

getId

getName

getCustomerPaymentAccountId

isSingleUsePaymentMethod

getStatus

getType

getGatewayType

getAmount

getSubtotal

getAdjustmentsTotal

getFulfillmentTotal

getTaxTotal

getBillingAddress

getPaymentGatewayProperties

getAttributes

getDisplayAttributes

getTransactions

isArchived

setId

setName

setCustomerPaymentAccountId

setSingleUsePaymentMethod

setShouldSavePaymentToCustomer

setStatus

setType

setGatewayType

setAmount

setSubtotal

setAdjustmentsTotal

setFulfillmentTotal

setTaxTotal

setBillingAddress

setPaymentGatewayProperties

setAttributes

setDisplayAttributes

setTransactions

setArchived

equals

canEqual

hashCode

toString