PaymentResponseDTO (BroadleafCommerce Common Libraries 3.1.2-GA API)

java.lang.Object
- org.broadleafcommerce.common.payment.dto.PaymentResponseDTO

```
public class PaymentResponseDTO
extends Object
```
The DTO object that represents the response coming back from any call to the Gateway. This can either wrap an API result call or a translated HTTP Web response. This can not only be the results of a transaction, but also a request for a Secure Token etc...

Note: the success and validity flags are set to true by default, unless otherwise overridden by specific gateway implementations

Author:

Elbert Bautista (elbertbautista)

Field Summary

Fields
Modifier and Type	Field and Description
`protected Money`	`amount` If this was a Transaction request, it will be the amount that was sent back from the gateway
`protected AddressDTO<PaymentResponseDTO>`	`billTo` The billing address associated with this transaction
`protected boolean`	`completeCheckoutOnCallback` Sets whether or not this module should complete checkout on callback.
`protected CreditCardDTO<PaymentResponseDTO>`	`creditCard` for sale/authorize transactions, this will be the Credit Card object that was charged.
`protected GatewayCustomerDTO<PaymentResponseDTO>`	`customer` Any customer information that relates to this transaction
`protected List<CustomerCreditDTO<PaymentResponseDTO>>`	`customerCredits` Any customer credit accounts that have been processed.
`protected List<GiftCardDTO<PaymentResponseDTO>>`	`giftCards` Any gift cards that have been processed.
`protected String`	`orderId` The Order ID that this transaction is associated with
`protected PaymentGatewayType`	`paymentGatewayType` The Payment Gateway Type that this transaction response represents
`protected PaymentTransactionType`	`paymentTransactionType` The Transaction Type of the Payment that this response represents
`protected PaymentType`	`paymentType` The Type of Payment that this transaction response represents
`protected String`	`rawResponse` A string representation of the response that came from the gateway.
`protected Map<String,String>`	`responseMap` A more convenient representation of `rawResponse` to hold the response from the gateway.
`protected AddressDTO<PaymentResponseDTO>`	`shipTo` If shipping information is captured on the gateway, the values sent back will be put here
`protected boolean`	`successful` Whether or not the transaction on the gateway was successful.
`protected boolean`	`valid` Whether or not this response was tampered with.

Constructor Summary

Constructors
Constructor and Description

PaymentResponseDTO(PaymentType paymentType, PaymentGatewayType gatewayType)

Constructors
Constructor and Description
`PaymentResponseDTO(PaymentType paymentType, PaymentGatewayType gatewayType)`

Method Summary

Methods
Modifier and Type	Method and Description
`PaymentResponseDTO`	`amount(Money amount)`
`AddressDTO<PaymentResponseDTO>`	`billTo()`
`PaymentResponseDTO`	`completeCheckoutOnCallback(boolean completeCheckoutOnCallback)`
`CreditCardDTO<PaymentResponseDTO>`	`creditCard()`
`GatewayCustomerDTO<PaymentResponseDTO>`	`customer()`
`CustomerCreditDTO<PaymentResponseDTO>`	`customerCredit()`
`Money`	`getAmount()`
`AddressDTO<PaymentResponseDTO>`	`getBillTo()`
`CreditCardDTO<PaymentResponseDTO>`	`getCreditCard()`
`GatewayCustomerDTO<PaymentResponseDTO>`	`getCustomer()`
`List<CustomerCreditDTO<PaymentResponseDTO>>`	`getCustomerCredits()`
`List<GiftCardDTO<PaymentResponseDTO>>`	`getGiftCards()`
`String`	`getOrderId()`
`PaymentGatewayType`	`getPaymentGatewayType()`
`PaymentTransactionType`	`getPaymentTransactionType()`
`PaymentType`	`getPaymentType()`
`String`	`getRawResponse()`
`Map<String,String>`	`getResponseMap()`
`AddressDTO<PaymentResponseDTO>`	`getShipTo()`
`GiftCardDTO<PaymentResponseDTO>`	`giftCard()`
`boolean`	`isCompleteCheckoutOnCallback()`
`boolean`	`isSuccessful()`
`boolean`	`isValid()`
`PaymentResponseDTO`	`orderId(String orderId)`
`PaymentResponseDTO`	`paymentTransactionType(PaymentTransactionType paymentTransactionType)`
`PaymentResponseDTO`	`rawResponse(String rawResponse)`
`PaymentResponseDTO`	`responseMap(String key, String value)`
`AddressDTO<PaymentResponseDTO>`	`shipTo()`
`PaymentResponseDTO`	`successful(boolean successful)`
`PaymentResponseDTO`	`valid(boolean valid)`

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

- Field Detail
  - customer
```
protected GatewayCustomerDTO<PaymentResponseDTO> customer
```
    Any customer information that relates to this transaction
  - shipTo
```
protected AddressDTO<PaymentResponseDTO> shipTo
```
    If shipping information is captured on the gateway, the values sent back will be put here
  - billTo
```
protected AddressDTO<PaymentResponseDTO> billTo
```
    The billing address associated with this transaction
  - creditCard
```
protected CreditCardDTO<PaymentResponseDTO> creditCard
```
    for sale/authorize transactions, this will be the Credit Card object that was charged. This data is useful for showing on an order confirmation screen.
  - giftCards
```
protected List<GiftCardDTO<PaymentResponseDTO>> giftCards
```
    Any gift cards that have been processed. This data is useful for showing on an order confirmation screen
  - customerCredits
```
protected List<CustomerCreditDTO<PaymentResponseDTO>> customerCredits
```
    Any customer credit accounts that have been processed. This data is useful for showing on an order confirmation screen
  - paymentGatewayType
```
protected PaymentGatewayType paymentGatewayType
```
    The Payment Gateway Type that this transaction response represents
  - paymentType
```
protected PaymentType paymentType
```
    The Type of Payment that this transaction response represents
  - paymentTransactionType
```
protected PaymentTransactionType paymentTransactionType
```
    The Transaction Type of the Payment that this response represents
  - orderId
```
protected String orderId
```
    The Order ID that this transaction is associated with
  - amount
```
protected Money amount
```
    If this was a Transaction request, it will be the amount that was sent back from the gateway
  - successful
```
protected boolean successful
```
    Whether or not the transaction on the gateway was successful. This should be provided by the gateway alone.
  - valid
```
protected boolean valid
```
    Whether or not this response was tampered with. This used to verify that the response that was received on the endpoint (which is intended to only be invoked from the payment gateway) actually came from the gateway and was not otherwise maliciously invoked by a 3rd-party.
  - completeCheckoutOnCallback
```
protected boolean completeCheckoutOnCallback
```
    Sets whether or not this module should complete checkout on callback. In most Credit Card gateway implementation, this should be set to 'TRUE' and should not be configurable as the gateway expects it to tbe the final step in the checkout process.
    
    In gateways where it does not expect to be the last step in the checkout process, for example BLC Gift Card Module, PayPal Express Checkout, etc... The callback from the gateway can be configured whether or not to complete checkout.
  - rawResponse
```
protected String rawResponse
```
    A string representation of the response that came from the gateway. This should be a string serialization of responseMap.
  - responseMap
```
protected Map<String,String> responseMap
```
    A more convenient representation of rawResponse to hold the response from the gateway.
- Constructor Detail
  - PaymentResponseDTO
```
public PaymentResponseDTO(PaymentType paymentType,
                  PaymentGatewayType gatewayType)
```
- Method Detail
  - customer
```
public GatewayCustomerDTO<PaymentResponseDTO> customer()
```
  - creditCard
```
public CreditCardDTO<PaymentResponseDTO> creditCard()
```
  - shipTo
```
public AddressDTO<PaymentResponseDTO> shipTo()
```
  - billTo
```
public AddressDTO<PaymentResponseDTO> billTo()
```
  - giftCard
```
public GiftCardDTO<PaymentResponseDTO> giftCard()
```
  - customerCredit
```
public CustomerCreditDTO<PaymentResponseDTO> customerCredit()
```
  - responseMap
```
public PaymentResponseDTO responseMap(String key,
                             String value)
```
  - orderId
```
public PaymentResponseDTO orderId(String orderId)
```
  - amount
```
public PaymentResponseDTO amount(Money amount)
```
  - paymentTransactionType
```
public PaymentResponseDTO paymentTransactionType(PaymentTransactionType paymentTransactionType)
```
  - successful
```
public PaymentResponseDTO successful(boolean successful)
```
  - completeCheckoutOnCallback
```
public PaymentResponseDTO completeCheckoutOnCallback(boolean completeCheckoutOnCallback)
```
  - valid
```
public PaymentResponseDTO valid(boolean valid)
```
  - rawResponse
```
public PaymentResponseDTO rawResponse(String rawResponse)
```
  - getCustomer
```
public GatewayCustomerDTO<PaymentResponseDTO> getCustomer()
```
  - getShipTo
```
public AddressDTO<PaymentResponseDTO> getShipTo()
```
  - getBillTo
```
public AddressDTO<PaymentResponseDTO> getBillTo()
```
  - getGiftCards
```
public List<GiftCardDTO<PaymentResponseDTO>> getGiftCards()
```
  - getCustomerCredits
```
public List<CustomerCreditDTO<PaymentResponseDTO>> getCustomerCredits()
```
  - getPaymentType
```
public PaymentType getPaymentType()
```
  - getPaymentGatewayType
```
public PaymentGatewayType getPaymentGatewayType()
```
  - getOrderId
```
public String getOrderId()
```
  - getAmount
```
public Money getAmount()
```
  - getPaymentTransactionType
```
public PaymentTransactionType getPaymentTransactionType()
```
  - isSuccessful
```
public boolean isSuccessful()
```
  - isValid
```
public boolean isValid()
```
  - isCompleteCheckoutOnCallback
```
public boolean isCompleteCheckoutOnCallback()
```
  - getCreditCard
```
public CreditCardDTO<PaymentResponseDTO> getCreditCard()
```
  - getRawResponse
```
public String getRawResponse()
```
  - getResponseMap
```
public Map<String,String> getResponseMap()
```

Class PaymentResponseDTO

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

customer

shipTo

billTo

creditCard

giftCards

customerCredits

paymentGatewayType

paymentType

paymentTransactionType

orderId

amount

successful

valid

completeCheckoutOnCallback

rawResponse

responseMap

Constructor Detail

PaymentResponseDTO

Method Detail

customer

creditCard

shipTo

billTo

giftCard

customerCredit

responseMap

orderId

amount

paymentTransactionType

successful

completeCheckoutOnCallback

valid

rawResponse

getCustomer

getShipTo

getBillTo

getGiftCards

getCustomerCredits

getPaymentType

getPaymentGatewayType

getOrderId

getAmount

getPaymentTransactionType

isSuccessful

isValid

isCompleteCheckoutOnCallback

getCreditCard

getRawResponse

getResponseMap