java.lang.Object
- com.broadleafcommerce.customer.service.provider.domain.PaymentTransaction

All Implemented Interfaces:

Serializable
```
@Deprecated(since="1.7.2",
            forRemoval=true)
public class PaymentTransaction
extends Object
implements Serializable
```
Deprecated, for removal: This API element is subject to removal in a future version.
since 1.7.2, in favor of using PaymentTransactionServices as saved payment method storage location.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

PaymentTransaction()
Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`protected boolean`	`canEqual(Object other)`	Deprecated, for removal: This API element is subject to removal in a future version.
`boolean`	`equals(Object o)`	Deprecated, for removal: This API element is subject to removal in a future version.
`Map<String,String>`	`getAttributes()`	Deprecated, for removal: This API element is subject to removal in a future version. Map of specific attributes that have been gathered from the raw response.
`Instant`	`getDateRecorded()`	Deprecated, for removal: This API element is subject to removal in a future version. The timestamp when this transaction response was recorded
`String`	`getDeclineType()`	Deprecated, for removal: This API element is subject to removal in a future version. The type of transaction failure (hard vs soft failure)
`String`	`getFailureType()`	Deprecated, for removal: This API element is subject to removal in a future version. The type of transaction failure
`String`	`getGatewayResponseCode()`	Deprecated, for removal: This API element is subject to removal in a future version. The response code provided by the payment gateway which may represent a success or failure
`String`	`getId()`	Deprecated, for removal: This API element is subject to removal in a future version. The id of this payment transaction.
`String`	`getParentTransactionId()`	Deprecated, for removal: This API element is subject to removal in a future version. The id of the parent `PaymentTransaction`.
`String`	`getStatus()`	Deprecated, for removal: This API element is subject to removal in a future version. The status of the transaction
`String`	`getTransactionReferenceId()`	Deprecated, for removal: This API element is subject to removal in a future version. The transaction id known by the payment gateway.
`String`	`getType()`	Deprecated, for removal: This API element is subject to removal in a future version. The type of this transaction (authorize, capture, refund, etc.)
`int`	`hashCode()`	Deprecated, for removal: This API element is subject to removal in a future version.
`void`	`setAttributes(Map<String,String> attributes)`	Deprecated, for removal: This API element is subject to removal in a future version. Map of specific attributes that have been gathered from the raw response.
`void`	`setDateRecorded(Instant dateRecorded)`	Deprecated, for removal: This API element is subject to removal in a future version. The timestamp when this transaction response was recorded
`void`	`setDeclineType(String declineType)`	Deprecated, for removal: This API element is subject to removal in a future version. The type of transaction failure (hard vs soft failure)
`void`	`setFailureType(String failureType)`	Deprecated, for removal: This API element is subject to removal in a future version. The type of transaction failure
`void`	`setGatewayResponseCode(String gatewayResponseCode)`	Deprecated, for removal: This API element is subject to removal in a future version. The response code provided by the payment gateway which may represent a success or failure
`void`	`setId(String id)`	Deprecated, for removal: This API element is subject to removal in a future version. The id of this payment transaction.
`void`	`setParentTransactionId(String parentTransactionId)`	Deprecated, for removal: This API element is subject to removal in a future version. The id of the parent `PaymentTransaction`.
`void`	`setStatus(String status)`	Deprecated, for removal: This API element is subject to removal in a future version. The status of the transaction
`void`	`setTransactionReferenceId(String transactionReferenceId)`	Deprecated, for removal: This API element is subject to removal in a future version. The transaction id known by the payment gateway.
`void`	`setType(String type)`	Deprecated, for removal: This API element is subject to removal in a future version. The type of this transaction (authorize, capture, refund, etc.)
`String`	`toString()`	Deprecated, for removal: This API element is subject to removal in a future version.
`boolean`	`wasSuccessful()`	Deprecated, for removal: This API element is subject to removal in a future version. 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()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
- Method Detail
  - wasSuccessful
```
public boolean wasSuccessful()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    Whether or not this transaction was successful based on getStatus().
    
    Returns:
    
    Whether or not this transaction was successful.
    
    See Also:
    
    getStatus()
  - getId
```
public String getId()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    The id of this payment transaction.
    
    Returns:
    
    The id of this payment transaction.
  - getType
```
public String getType()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    The type of this transaction (authorize, capture, refund, etc.)
    
    Returns:
    
    The type of this transaction (authorize, capture, refund, etc.)
  - getStatus
```
public String getStatus()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    The status of the transaction
    
    Returns:
    
    The status of the transaction
  - getTransactionReferenceId
```
public String getTransactionReferenceId()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    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
  - getDateRecorded
```
public Instant getDateRecorded()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    The timestamp when this transaction response was recorded
    
    Returns:
    
    The timestamp when this transaction response was recorded
  - getGatewayResponseCode
```
public String getGatewayResponseCode()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    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()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    The type of transaction failure
    
    Returns:
    
    The type of transaction failure
  - getDeclineType
```
public String getDeclineType()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    The type of transaction failure (hard vs soft failure)
    
    Returns:
    
    The type of transaction failure (hard vs soft failure)
  - getParentTransactionId
```
public String getParentTransactionId()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    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
    
    Refund -> Capture
    
    Refund -> AuthorizeAndCapture
    Returns:
    
    The id of the parent PaymentTransaction.
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    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
  - setId
```
public void setId(String id)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    The id of this payment transaction.
    
    Parameters:
    
    paymentTransactionId - The id of this payment transaction.
  - setType
```
public void setType(String type)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    The type of this transaction (authorize, capture, refund, etc.)
    
    Parameters:
    
    amount - The type of this transaction
  - setStatus
```
public void setStatus(String status)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    The status of the transaction
    
    Parameters:
    
    status - The status of the transaction
  - setTransactionReferenceId
```
public void setTransactionReferenceId(String transactionReferenceId)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    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
  - setDateRecorded
```
public void setDateRecorded(Instant dateRecorded)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    The timestamp when this transaction response was recorded
    
    Parameters:
    
    dateRecorded - The timestamp when this transaction response was recorded
  - setGatewayResponseCode
```
public void setGatewayResponseCode(String gatewayResponseCode)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    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)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    The type of transaction failure
    
    Parameters:
    
    failureType - The type of transaction failure
  - setDeclineType
```
public void setDeclineType(String declineType)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    The type of transaction failure (hard vs soft failure)
    
    Parameters:
    
    failureType - The type of transaction failure (hard vs soft failure)
  - setParentTransactionId
```
public void setParentTransactionId(String parentTransactionId)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    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
    
    Refund -> Capture
    
    Refund -> AuthorizeAndCapture
    Parameters:
    
    parentTransactionId - The id of the parent PaymentTransaction.
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    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
  - equals
```
public boolean equals(Object o)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
    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.
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    
    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

getStatus

getTransactionReferenceId

getDateRecorded

getGatewayResponseCode

getFailureType

getDeclineType

getParentTransactionId

getAttributes

setId

setType

setStatus

setTransactionReferenceId

setDateRecorded

setGatewayResponseCode

setFailureType

setDeclineType

setParentTransactionId

setAttributes

equals

canEqual

hashCode

toString