PaymentTransaction (Broadleaf Order Common 1.4.0-GA API)

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

All Implemented Interfaces:

Serializable
```
public class PaymentTransaction
extends Object
implements Serializable
```
Used to store individual transactions about a particular payment. While a Payment 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 used to record transactional interactions with a payment gateway for a particular payment. Thus, PaymentTransactions do not make sense by themselves and ONLY make sense in the context of a Payment.

For instance, the user might pay $10, but rather than capture the payment during checkout, the business may first want to use & record an authorize-typed transaction. Later, when the business ships the item, a capture-typed transaction would be used & recorded.

In the above case, this also implies that a PaymentTransaction can have a parent transaction (retrieved via getParentTransactionId()). The parent transaction will only be set in the following cases:
- Child Transaction -> Parent Transaction
- Reverse Authorize -> Authorize
- Capture -> Authorize
- Void -> Capture
- Void -> AuthorizeAndCapture
- Settle -> Capture
- Refund -> Capture
- Refund -> AuthorizeAndCapture
- Refund -> Settle
Author:

Phillip Verheyden (phillipuniverse), Chris Kittrell (ckittrell)

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PaymentTransaction()

Constructors
Constructor and Description
`PaymentTransaction()`

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`	`getAmount()` The amount related to this transaction.
`Map<String,String>`	`getAttributes()` Map of specific attributes that have been gathered from the raw response.
`String`	`getCustomerIpAddress()` The customer IP address that instigated this transaction
`Instant`	`getDateRecorded()` The timestamp when this transaction response was recorded
`String`	`getDeclineType()` The type of transaction failure (hard vs soft failure)
`String`	`getFailureType()` The type of transaction failure
`String`	`getGatewayResponseCode()` The response code provided by the payment gateway which may represent a success or failure
`String`	`getId()` The id of this payment transaction.
`String`	`getManagementState()` The state of this transaction - e.g.
`String`	`getParentTransactionId()` The id of the parent `PaymentTransaction`.
`String`	`getRawResponse()` The string representation of the serialized response from the gateway.
`String`	`getRequestId()` The id used to represent the request that produced this transaction.
`String`	`getStatus()` The status of the transaction
`String`	`getTransactionReferenceId()` The transaction id known by the payment gateway.
`String`	`getType()` The type of this transaction (authorize, capture, refund, etc.)
`int`	`hashCode()`
`boolean`	`isIndeterminateResult()` Tells if this transaction has an indeterminate result.
`void`	`setAmount(javax.money.MonetaryAmount amount)` The amount related to this transaction.
`void`	`setAttributes(Map<String,String> attributes)` Map of specific attributes that have been gathered from the raw response.
`void`	`setCustomerIpAddress(String customerIpAddress)` The customer IP address that instigated this transaction
`void`	`setDateRecorded(Instant dateRecorded)` The timestamp when this transaction response was recorded
`void`	`setDeclineType(String declineType)` The type of transaction failure (hard vs soft failure)
`void`	`setFailureType(String failureType)` The type of transaction failure
`void`	`setGatewayResponseCode(String gatewayResponseCode)` The response code provided by the payment gateway which may represent a success or failure
`void`	`setId(String id)` The id of this payment transaction.
`void`	`setIndeterminateResult(boolean indeterminateResult)` Tells if this transaction has an indeterminate result.
`void`	`setManagementState(String managementState)` The state of this transaction - e.g.
`void`	`setParentTransactionId(String parentTransactionId)` The id of the parent `PaymentTransaction`.
`void`	`setRawResponse(String rawResponse)` The string representation of the serialized response from the gateway.
`void`	`setRequestId(String requestId)` The id used to represent the request that produced this transaction.
`void`	`setStatus(String status)` The status of the transaction
`void`	`setTransactionReferenceId(String transactionReferenceId)` The transaction id known by the payment gateway.
`void`	`setType(String type)` The type of this transaction (authorize, capture, refund, etc.)
`String`	`toString()`
`boolean`	`wasSuccessful()` Whether or not this transaction was successful based on `getStatus()`.

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

- Constructor Detail
  - PaymentTransaction
```
public PaymentTransaction()
```
- Method Detail
  - wasSuccessful
```
public boolean wasSuccessful()
```
    Whether or not this transaction was successful based on getStatus().
    
    Returns:
    
    Whether or not this transaction was successful.
    
    See Also:
    
    getStatus(), TransactionStatus
  - getId
```
public String getId()
```
    The id of this payment transaction.
    
    Returns:
    
    The id of this payment transaction.
  - getType
```
public String getType()
```
    The type of this transaction (authorize, capture, refund, etc.)
    
    Returns:
    
    The type of this transaction (authorize, capture, refund, etc.)
  - getManagementState
```
public String getManagementState()
```
    The state of this transaction - e.g. whether the transaction is scheduled for reversal or if it's being used in an active checkout. If the transaction was not successful, then we expect this value to be null.
    
    Returns:
    
    The state of this transaction
    
    See Also:
    
    TransactionManagementState
  - getStatus
```
public String getStatus()
```
    The status of the transaction
    
    Returns:
    
    The status of the transaction
    
    See Also:
    
    TransactionStatus
  - getTransactionReferenceId
```
public String getTransactionReferenceId()
```
    The transaction id known by the payment gateway. This reference can be used to link the request to the gateway's record of the transaction in the case that the calling application does not receive a response from the gateway.
    
    Returns:
    
    The transaction id known by the payment gateway
  - getRequestId
```
public String getRequestId()
```
    The id used to represent the request that produced this transaction. This is normally related to a checkout submission request.
    
    Returns:
    
    The id used to represent the request that produced this transaction
  - getAmount
```
public javax.money.MonetaryAmount getAmount()
```
    The amount related to this transaction. Depending on the type, this may be the amount authorized, captured, refunded, etc.
    
    Returns:
    
    The amount related to this transaction
  - getDateRecorded
```
public Instant getDateRecorded()
```
    The timestamp when this transaction response was recorded
    
    Returns:
    
    The timestamp when this transaction response was recorded
  - getGatewayResponseCode
```
public String getGatewayResponseCode()
```
    The response code provided by the payment gateway which may represent a success or failure
    
    Returns:
    
    The response code provided by the payment gateway which may represent a success or failure
  - getFailureType
```
public String getFailureType()
```
    The type of transaction failure
    
    Returns:
    
    The type of transaction failure
  - getDeclineType
```
public String getDeclineType()
```
    The type of transaction failure (hard vs soft failure)
    
    Returns:
    
    The type of transaction failure (hard vs soft failure)
  - getRawResponse
```
public String getRawResponse()
```
    The string representation of the serialized response from the gateway. This is usually the complete request parameter map serialized in string form.
    
    Returns:
    
    The string representation of the serialized response from the gateway
  - getParentTransactionId
```
public String getParentTransactionId()
```
    The id of the parent PaymentTransaction. Necessary for operations on a payment that require something to have happened beforehand. For instance, an authorize transaction would not have a parent but a capture must have an authorize parent transaction and a refund must have a capture parent transaction. The full set of expected parent-child transaction relationships are as follows:
    - Child Transaction -> Parent Transaction
    - Reverse Authorize -> Authorize
    - Capture -> Authorize
    - Void -> Capture
    - Void -> AuthorizeAndCapture
    - Settle -> Capture
    - Refund -> Capture
    - Refund -> AuthorizeAndCapture
    - Refund -> Settle
    Returns:
    
    The id of the parent PaymentTransaction.
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Map of specific attributes that have been gathered from the raw response. This should be used for data points that are to be used programmatically. For example, a gateway-specific transaction id that can be used to capture or refund the transaction.
    
    Returns:
    
    Map of specific fields that have been gathered from the raw response
    
    See Also:
    
    PaymentTransactionAdditionalFieldType
  - getCustomerIpAddress
```
public String getCustomerIpAddress()
```
    The customer IP address that instigated this transaction
    
    Returns:
    
    The customer IP address that instigated this transaction
  - isIndeterminateResult
```
public boolean isIndeterminateResult()
```
    Tells if this transaction has an indeterminate result.
    Having an indeterminate result means that the true outcome of the transaction is not known. For example, if a transaction is sent to the payment processor but a network error occurred, it is not known to us whether the user was actually charged or not (thus, the result is indeterminate).
    Transactions should be marked as indeterminate when sending to the payment processor, and then unmarked once a response is received, understood, and recorded. This means that a transaction in an indeterminate result state is expected during the sending to processor phase. However, if the transaction remains in that state for an excessive amount of time, something likely went wrong and the transaction will need to be reconciled. If the transaction changes from the sending to processor status but remains indeterminate, the transaction will also require reconciliation in that scenario.
    Some situations which may lead to an indeterminate result:
    - A transaction is sent to the processor, but a network error prevents us from receiving the response
    - A transaction is sent to the processor, but the processor returns an unexpected error (e.g. 500 internal server error)
    - A transaction is sent to the processor and a response is received, but cannot be recorded because Cart Services is down
    - A transaction is sent to the processor and a response is received, but cannot be recorded because the database is down
  - setId
```
public void setId(String id)
```
    The id of this payment transaction.
    
    Parameters:
    
    paymentTransactionId - The id of this payment transaction.
  - setType
```
public void setType(String type)
```
    The type of this transaction (authorize, capture, refund, etc.)
    
    Parameters:
    
    amount - The type of this transaction
  - setManagementState
```
public void setManagementState(String managementState)
```
    The state of this transaction - e.g. whether the transaction is scheduled for reversal or if it's being used in an active checkout. If the transaction was not successful, then we expect this value to be null.
    
    Parameters:
    
    managementState - The state of this transaction
    
    See Also:
    
    TransactionManagementState
  - setStatus
```
public void setStatus(String status)
```
    The status of the transaction
    
    Parameters:
    
    status - The status of the transaction
    
    See Also:
    
    TransactionStatus
  - setTransactionReferenceId
```
public void setTransactionReferenceId(String transactionReferenceId)
```
    The transaction id known by the payment gateway. This reference can be used to link the request to the gateway's record of the transaction in the case that the calling application does not receive a response from the gateway.
    
    Parameters:
    
    transactionReferenceId - The transaction id known by the payment gateway
  - setRequestId
```
public void setRequestId(String requestId)
```
    The id used to represent the request that produced this transaction. This is normally related to a checkout submission request.
    
    Parameters:
    
    requestId - The id used to represent the request that produced this transaction
  - setAmount
```
public void setAmount(javax.money.MonetaryAmount amount)
```
    The amount related to this transaction. Depending on the type, this may be the amount authorized, captured, refunded, etc.
    
    Parameters:
    
    amount - The amount related to this transaction
  - setDateRecorded
```
public void setDateRecorded(Instant dateRecorded)
```
    The timestamp when this transaction response was recorded
    
    Parameters:
    
    dateRecorded - The timestamp when this transaction response was recorded
  - setGatewayResponseCode
```
public void setGatewayResponseCode(String gatewayResponseCode)
```
    The response code provided by the payment gateway which may represent a success or failure
    
    Parameters:
    
    gatewayResponseCode - The response code provided by the payment gateway which may represent a success or failure
  - setFailureType
```
public void setFailureType(String failureType)
```
    The type of transaction failure
    
    Parameters:
    
    failureType - The type of transaction failure
  - setDeclineType
```
public void setDeclineType(String declineType)
```
    The type of transaction failure (hard vs soft failure)
    
    Parameters:
    
    failureType - The type of transaction failure (hard vs soft failure)
  - setRawResponse
```
public void setRawResponse(String rawResponse)
```
    The string representation of the serialized response from the gateway. This is usually the complete request parameter map serialized in string form.
    
    Parameters:
    
    rawResponse - The string representation of the serialized response from the gateway
  - setParentTransactionId
```
public void setParentTransactionId(String parentTransactionId)
```
    The id of the parent PaymentTransaction. Necessary for operations on a payment that require something to have happened beforehand. For instance, an authorize transaction would not have a parent but a capture must have an authorize parent transaction and a refund must have a capture parent transaction. The full set of expected parent-child transaction relationships are as follows:
    - Child Transaction -> Parent Transaction
    - Reverse Authorize -> Authorize
    - Capture -> Authorize
    - Void -> Capture
    - Void -> AuthorizeAndCapture
    - Settle -> Capture
    - Refund -> Capture
    - Refund -> AuthorizeAndCapture
    - Refund -> Settle
    Parameters:
    
    parentTransactionId - The id of the parent PaymentTransaction.
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    Map of specific attributes that have been gathered from the raw response. This should be used for data points that are to be used programmatically. For example, a gateway-specific transaction id that can be used to capture or refund the transaction.
    
    Parameters:
    
    attributes - Map of specific fields that have been gathered from the raw response
    
    See Also:
    
    PaymentTransactionAdditionalFieldType
  - setCustomerIpAddress
```
public void setCustomerIpAddress(String customerIpAddress)
```
    The customer IP address that instigated this transaction
    
    Parameters:
    
    customerIpAddress - The customer IP address that instigated this transaction
  - setIndeterminateResult
```
public void setIndeterminateResult(boolean indeterminateResult)
```
    Tells if this transaction has an indeterminate result.
    Having an indeterminate result means that the true outcome of the transaction is not known. For example, if a transaction is sent to the payment processor but a network error occurred, it is not known to us whether the user was actually charged or not (thus, the result is indeterminate).
    Transactions should be marked as indeterminate when sending to the payment processor, and then unmarked once a response is received, understood, and recorded. This means that a transaction in an indeterminate result state is expected during the sending to processor phase. However, if the transaction remains in that state for an excessive amount of time, something likely went wrong and the transaction will need to be reconciled. If the transaction changes from the sending to processor status but remains indeterminate, the transaction will also require reconciliation in that scenario.
    Some situations which may lead to an indeterminate result:
    - A transaction is sent to the processor, but a network error prevents us from receiving the response
    - A transaction is sent to the processor, but the processor returns an unexpected error (e.g. 500 internal server error)
    - A transaction is sent to the processor and a response is received, but cannot be recorded because Cart Services is down
    - A transaction is sent to the processor and a response is received, but cannot be recorded because the database is down
  - 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 PaymentTransaction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PaymentTransaction

Method Detail

wasSuccessful

getId

getType

getManagementState

getStatus

getTransactionReferenceId

getRequestId

getAmount

getDateRecorded

getGatewayResponseCode

getFailureType

getDeclineType

getRawResponse

getParentTransactionId

getAttributes

getCustomerIpAddress

isIndeterminateResult

setId

setType

setManagementState

setStatus

setTransactionReferenceId

setRequestId

setAmount

setDateRecorded

setGatewayResponseCode

setFailureType

setDeclineType

setRawResponse

setParentTransactionId

setAttributes

setCustomerIpAddress

setIndeterminateResult

equals

canEqual

hashCode

toString