PaymentResponseItem (BroadleafCommerce Framework 2.4.2-GA API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

PaymentResponseItemImpl
```
public interface PaymentResponseItem
extends Serializable
```

Method Summary

Methods
Modifier and Type	Method and Description
`Map<String,String>`	`getAdditionalFields()`
`Money`	`getAmountPaid()` Deprecated.
`String`	`getAuthorizationCode()`
`String`	`getAvsCode()`
`BroadleafCurrency`	`getCurrency()`
`Customer`	`getCustomer()`
`String`	`getCvvCode()`
`String`	`getImplementorResponseCode()`
`String`	`getImplementorResponseText()`
`String`	`getMiddlewareResponseCode()`
`String`	`getMiddlewareResponseText()`
`Long`	`getPaymentInfoId()`
`String`	`getPaymentInfoReferenceNumber()`
`String`	`getProcessorResponseCode()`
`String`	`getProcessorResponseText()`
`String`	`getReferenceNumber()`
`Money`	`getRemainingBalance()`
`Money`	`getTransactionAmount()` The amount that the system processed.
`String`	`getTransactionId()`
`Boolean`	`getTransactionSuccess()`
`Date`	`getTransactionTimestamp()`
`TransactionType`	`getTransactionType()`
`String`	`getUserName()`
`void`	`setAdditionalFields(Map<String,String> additionalFields)`
`void`	`setAmountPaid(Money amount)` Deprecated. setTransactionAmount() instead.
`void`	`setAuthorizationCode(String authorizationCode)`
`void`	`setAvsCode(String avsCode)`
`void`	`setCurrency(BroadleafCurrency currency)`
`void`	`setCustomer(Customer customer)`
`void`	`setCvvCode(String cvvCode)`
`void`	`setImplementorResponseCode(String implementorResponseCode)`
`void`	`setImplementorResponseText(String implementorResponseText)`
`void`	`setMiddlewareResponseCode(String middlewareResponseCode)`
`void`	`setMiddlewareResponseText(String middlewareResponseText)`
`void`	`setPaymentInfoId(Long paymentInfoId)`
`void`	`setPaymentInfoReferenceNumber(String paymentInfoReferenceNumber)`
`void`	`setProcessorResponseCode(String processorResponseCode)`
`void`	`setProcessorResponseText(String processorResponseText)`
`void`	`setReferenceNumber(String referenceNumber)`
`void`	`setRemainingBalance(Money remainingBalance)`
`void`	`setTransactionAmount(Money amount)` Sets the transaction amount.
`void`	`setTransactionId(String transactionId)`
`void`	`setTransactionSuccess(Boolean transactionSuccess)`
`void`	`setTransactionTimestamp(Date transactionTimestamp)`
`void`	`setTransactionType(TransactionType transactionType)`
`void`	`setUserName(String userName)`

Method Detail

getAuthorizationCode
```
String getAuthorizationCode()
```

setAuthorizationCode

void setAuthorizationCode(String authorizationCode)

getMiddlewareResponseCode
```
String getMiddlewareResponseCode()
```

setMiddlewareResponseCode

void setMiddlewareResponseCode(String middlewareResponseCode)

getMiddlewareResponseText
```
String getMiddlewareResponseText()
```

setMiddlewareResponseText

void setMiddlewareResponseText(String middlewareResponseText)

getProcessorResponseCode
```
String getProcessorResponseCode()
```

setProcessorResponseCode

void setProcessorResponseCode(String processorResponseCode)

getProcessorResponseText
```
String getProcessorResponseText()
```

setProcessorResponseText

void setProcessorResponseText(String processorResponseText)

getReferenceNumber
```
String getReferenceNumber()
```

setReferenceNumber

void setReferenceNumber(String referenceNumber)

getAmountPaid
```
Money getAmountPaid()
```
Deprecated.

See Also:
getTransactionAmount()

setAmountPaid
```
void setAmountPaid(Money amount)
```
Deprecated. setTransactionAmount() instead.

See Also:
setTransactionAmount(org.broadleafcommerce.common.money.Money)

getTransactionAmount
```
Money getTransactionAmount()
```
The amount that the system processed. For example, when submitting an order, this would be the order.getTotal. If refunding $10, this would be 10.

Returns:

setTransactionAmount
```
void setTransactionAmount(Money amount)
```
Sets the transaction amount.

Parameters:
amount -

getTransactionSuccess
```
Boolean getTransactionSuccess()
```

setTransactionSuccess

void setTransactionSuccess(Boolean transactionSuccess)

getTransactionTimestamp
```
Date getTransactionTimestamp()
```

setTransactionTimestamp

void setTransactionTimestamp(Date transactionTimestamp)

getImplementorResponseCode
```
String getImplementorResponseCode()
```

setImplementorResponseCode

void setImplementorResponseCode(String implementorResponseCode)

getImplementorResponseText
```
String getImplementorResponseText()
```

setImplementorResponseText

void setImplementorResponseText(String implementorResponseText)

getTransactionId
```
String getTransactionId()
```

setTransactionId

void setTransactionId(String transactionId)

getAvsCode
```
String getAvsCode()
```

setAvsCode
```
void setAvsCode(String avsCode)
```

getCvvCode
```
String getCvvCode()
```

setCvvCode
```
void setCvvCode(String cvvCode)
```

getRemainingBalance
```
Money getRemainingBalance()
```

setRemainingBalance

void setRemainingBalance(Money remainingBalance)

getTransactionType
```
TransactionType getTransactionType()
```

setTransactionType

void setTransactionType(TransactionType transactionType)

getAdditionalFields

Map<String,String> getAdditionalFields()

setAdditionalFields

void setAdditionalFields(Map<String,String> additionalFields)

getPaymentInfoId
```
Long getPaymentInfoId()
```

setPaymentInfoId

void setPaymentInfoId(Long paymentInfoId)

getUserName
```
String getUserName()
```

setUserName
```
void setUserName(String userName)
```

getCustomer
```
Customer getCustomer()
```

setCustomer
```
void setCustomer(Customer customer)
```

getPaymentInfoReferenceNumber
```
String getPaymentInfoReferenceNumber()
```

setPaymentInfoReferenceNumber

void setPaymentInfoReferenceNumber(String paymentInfoReferenceNumber)

setCurrency

void setCurrency(BroadleafCurrency currency)

getCurrency
```
BroadleafCurrency getCurrency()
```

Interface PaymentResponseItem

Method Summary

Method Detail

getAuthorizationCode

setAuthorizationCode

getMiddlewareResponseCode

setMiddlewareResponseCode

getMiddlewareResponseText

setMiddlewareResponseText

getProcessorResponseCode

setProcessorResponseCode

getProcessorResponseText

setProcessorResponseText

getReferenceNumber

setReferenceNumber

getAmountPaid

setAmountPaid

getTransactionAmount

setTransactionAmount

getTransactionSuccess

setTransactionSuccess

getTransactionTimestamp

setTransactionTimestamp

getImplementorResponseCode

setImplementorResponseCode

getImplementorResponseText

setImplementorResponseText

getTransactionId

setTransactionId

getAvsCode

setAvsCode

getCvvCode

setCvvCode

getRemainingBalance

setRemainingBalance

getTransactionType

setTransactionType

getAdditionalFields

setAdditionalFields

getPaymentInfoId

setPaymentInfoId

getUserName

setUserName

getCustomer

setCustomer

getPaymentInfoReferenceNumber

setPaymentInfoReferenceNumber

setCurrency

getCurrency