AddPaymentRequest (Broadleaf Cart Operation Services 1.6.0-GA API)

java.lang.Object
- com.broadleafcommerce.cartoperation.web.endpoint.domain.CartModifyingRequest
- - com.broadleafcommerce.cartoperation.web.endpoint.domain.AddPaymentRequest

All Implemented Interfaces:

CartVersionedRequest, Serializable
```
public class AddPaymentRequest
extends CartModifyingRequest
implements Serializable
```
A request DTO used to create and add a Payment to the resolved Cart.

Author:

Chad Harchar (charchar)

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AddPaymentRequest()

Constructors
Constructor and Description
`AddPaymentRequest()`

Method Summary

All Methods Instance Methods Concrete 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 the payment is allotted.
`Map<String,String>`	`getAttributes()` Map to capture any additional information about the payment
`com.broadleafcommerce.order.common.domain.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`	`getName()` The name of this payment.
`Map<String,String>`	`getPaymentGatewayProperties()` Map to capture any gateway-specific information needed to perform gateway transactions
`javax.money.MonetaryAmount`	`getSubtotal()` The payment's total usually excluding adjustments, tax, and shipping.
`javax.money.MonetaryAmount`	`getTaxTotal()` The payment's total tax cost
`String`	`getType()` The type of this payment like Credit Card or Gift Card.
`int`	`hashCode()`
`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 the payment is allotted.
`void`	`setAttributes(Map<String,String> attributes)` Map to capture any additional information about the payment
`void`	`setBillingAddress(com.broadleafcommerce.order.common.domain.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`	`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`	`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`	`setType(String type)` The type of this payment like Credit Card or Gift Card.
`boolean`	`shouldSavePaymentToCustomer()` Should the payment method be saved to the customer
`String`	`toString()`

Methods inherited from class com.broadleafcommerce.cartoperation.web.endpoint.domain.CartModifyingRequest
getCartVersion, getVersion, setCartVersion, setVersion

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

- Constructor Detail
  - AddPaymentRequest
```
public AddPaymentRequest()
```
- Method Detail
  - shouldSavePaymentToCustomer
```
public boolean shouldSavePaymentToCustomer()
```
    Should the payment method be saved to the customer
    
    Returns:
    
    Should the payment method be saved to the customer
  - 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
  - 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.
    
    See Also:
    
    DefaultPaymentTypes
  - 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.
    
    See Also:
    
    PaymentGatewayType
  - getAmount
```
public javax.money.MonetaryAmount getAmount()
```
    The amount for which the payment is allotted.
    
    Returns:
    
    The amount for which the 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 com.broadleafcommerce.order.common.domain.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
  - 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
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Map to capture any additional information about the payment
    
    Returns:
    
    Map to capture any additional information about the payment
  - 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
  - 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.
    
    See Also:
    
    DefaultPaymentTypes
  - 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.
    
    See Also:
    
    PaymentGatewayType
  - setAmount
```
public void setAmount(javax.money.MonetaryAmount amount)
```
    The amount for which the payment is allotted.
    
    Parameters:
    
    amount - The amount for which the 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(com.broadleafcommerce.order.common.domain.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
  - 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
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    Map to capture any additional information about the payment
    
    Parameters:
    
    attributes - Map to capture any additional information about the payment
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class CartModifyingRequest
  - canEqual
```
protected boolean canEqual(Object other)
```
    Overrides:
    
    canEqual in class CartModifyingRequest
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class CartModifyingRequest
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class CartModifyingRequest

Class AddPaymentRequest

Constructor Summary

Method Summary

Methods inherited from class com.broadleafcommerce.cartoperation.web.endpoint.domain.CartModifyingRequest

Methods inherited from class java.lang.Object

Constructor Detail

AddPaymentRequest

Method Detail

shouldSavePaymentToCustomer

getName

getCustomerPaymentAccountId

isSingleUsePaymentMethod

getType

getGatewayType

getAmount

getSubtotal

getAdjustmentsTotal

getFulfillmentTotal

getTaxTotal

getBillingAddress

getPaymentGatewayProperties

getDisplayAttributes

getAttributes

setName

setCustomerPaymentAccountId

setSingleUsePaymentMethod

setShouldSavePaymentToCustomer

setType

setGatewayType

setAmount

setSubtotal

setAdjustmentsTotal

setFulfillmentTotal

setTaxTotal

setBillingAddress

setPaymentGatewayProperties

setDisplayAttributes

setAttributes

equals

canEqual

hashCode

toString