PaymentTransaction (BroadleafCommerce Framework 6.2.2-GA API)

All Superinterfaces:

AdditionalFields, MultiTenantCloneable<PaymentTransaction>, Serializable, Status

All Known Implementing Classes:

PaymentTransactionImpl
```
public interface PaymentTransaction
extends Serializable, Status, AdditionalFields, MultiTenantCloneable<PaymentTransaction>
```
Used to store individual transactions about a particular payment. While an OrderPayment holds data like what the user might be paying with and the total amount they will be paying (like credit card and $10), a PaymentTransaction is more about what happens with that particular payment. Thus, PaymentTransactions do not make sense by themselves and ONLY make sense in the context of an OrderPayment.

For instance, the user might say they want to pay $10 but rather than capture the payment at order checkout, there might first be a transaction for PaymentTransactionType.AUTHORIZE and then when the item is shipped there is another PaymentTransaction for PaymentTransactionType.CAPTURE.

In the above case, this also implies that a PaymentTransaction can have a parent transaction (retrieved via getParentTransaction()). The parent transaction will only be set in the following cases:
For PaymentTransactionType.UNCONFIRMED, they will have children that will be either PaymentTransactionType.AUTHORIZE or PaymentTransactionType.AUTHORIZE_AND_CAPTURE.
*
Author:

Phillip Verheyden (phillipuniverse)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Map<String,String>`	`getAdditionalFields()`
`Money`	`getAmount()` Gets the amount that this transaction is for
`String`	`getCustomerIpAddress()` Gets the `Customer` IP address that instigated this transaction.
`Date`	`getDate()` Gets the date that this transaction was made on
`Long`	`getId()`
`OrderPayment`	`getOrderPayment()` The overall payment that this transaction applies to.
`PaymentTransaction`	`getParentTransaction()` Transactions can have a parent-child relationship for modifying transactions that can occur.
`String`	`getRawResponse()` Gets the string-representation of the serialized response from the gateway.
`Boolean`	`getSuccess()` Gets whether or not this transaction was successful.
`PaymentTransactionType`	`getType()` The type of
`boolean`	`isSaveToken()` Indicates whether or not this transaction on the Order Payment contains a payment token (i.e.
`void`	`setAdditionalFields(Map<String,String> additionalFields)`
`void`	`setAmount(Money amount)` Sets the amount of this transaction
`void`	`setCustomerIpAddress(String customerIpAddress)` Sets the `Customer` IP address that instigated the transaction.
`void`	`setDate(Date date)` Sets the date that this transaction was made on
`void`	`setId(Long id)`
`void`	`setOrderPayment(OrderPayment payment)` Sets the overall payment that this transaction applies to
`void`	`setParentTransaction(PaymentTransaction parentTransaction)`
`void`	`setRawResponse(String rawResponse)` Sets the raw response that was returned from the gateway.
`void`	`setSaveToken(boolean saveToken)` Mark this transaction as containing (or going to contain) a token that should be saved on the user's profile as a `CustomerPayment`
`void`	`setSuccess(Boolean success)`
`void`	`setType(PaymentTransactionType type)`

Methods inherited from interface org.broadleafcommerce.common.persistence.Status
getArchived, isActive, setArchived

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable
createOrRetrieveCopyInstance

- Method Detail
  - getId
```
Long getId()
```
  - setId
```
void setId(Long id)
```
  - getOrderPayment
```
OrderPayment getOrderPayment()
```
    The overall payment that this transaction applies to. Note that if the relationship to an order payment is unset on this particular transaction, then this will automatically attempt to obtain the OrderPayment from getParentTransaction().
  - setOrderPayment
```
void setOrderPayment(OrderPayment payment)
```
    Sets the overall payment that this transaction applies to
  - getParentTransaction
```
PaymentTransaction getParentTransaction()
```
    Transactions can have a parent-child relationship for modifying transactions that can occur. Examples of this:
    For PaymentTransactionType.UNCONFIRMED, they will have children that will be either PaymentTransactionType.AUTHORIZE or PaymentTransactionType.AUTHORIZE_AND_CAPTURE.
    Returns:
  - setParentTransaction
```
void setParentTransaction(PaymentTransaction parentTransaction)
```
  - getType
```
PaymentTransactionType getType()
```
    The type of
    
    Returns:
  - setType
```
void setType(PaymentTransactionType type)
```
  - getAmount
```
Money getAmount()
```
    Gets the amount that this transaction is for
  - setAmount
```
void setAmount(Money amount)
```
    Sets the amount of this transaction
  - getDate
```
Date getDate()
```
    Gets the date that this transaction was made on
  - setDate
```
void setDate(Date date)
```
    Sets the date that this transaction was made on
  - getCustomerIpAddress
```
String getCustomerIpAddress()
```
    Gets the Customer IP address that instigated this transaction. This is an optional field
  - setCustomerIpAddress
```
void setCustomerIpAddress(String customerIpAddress)
```
    Sets the Customer IP address that instigated the transaction. This is an optional field.
  - getRawResponse
```
String getRawResponse()
```
    Gets the string-representation of the serialized response from the gateway. This is usually the complete request parameter map serialized in string form.
  - setRawResponse
```
void setRawResponse(String rawResponse)
```
    Sets the raw response that was returned from the gateway.
  - getSuccess
```
Boolean getSuccess()
```
    Gets whether or not this transaction was successful. There are multiple reasons that a transaction could be unsuccessful such as failed credit card processing or any other errors from the gateway.
  - setSuccess
```
void setSuccess(Boolean success)
```
  - getAdditionalFields
```
Map<String,String> getAdditionalFields()
```
    Specified by:
    
    getAdditionalFields in interface AdditionalFields
    
    See Also:
    
    PaymentAdditionalFieldType}
  - setAdditionalFields
```
void setAdditionalFields(Map<String,String> additionalFields)
```
    Specified by:
    
    setAdditionalFields in interface AdditionalFields
  - isSaveToken
```
boolean isSaveToken()
```
    Indicates whether or not this transaction on the Order Payment contains a payment token (i.e. PaymentAdditionalFieldType.TOKEN) and should be saved as a CustomerPayment on the user's profile
    
    Returns:
    
    - whether or not this transaction should be tokenized
  - setSaveToken
```
void setSaveToken(boolean saveToken)
```
    Mark this transaction as containing (or going to contain) a token that should be saved on the user's profile as a CustomerPayment
    
    Parameters:
    
    saveToken -

Interface PaymentTransaction

Method Summary

Methods inherited from interface org.broadleafcommerce.common.persistence.Status

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable

Method Detail

getId

setId

getOrderPayment

setOrderPayment

getParentTransaction

setParentTransaction

getType

setType

getAmount

setAmount

getDate

setDate

getCustomerIpAddress

setCustomerIpAddress

getRawResponse

setRawResponse

getSuccess

setSuccess

getAdditionalFields

setAdditionalFields

isSaveToken

setSaveToken