Package org.broadleafcommerce.common.payment.dto

Class PaymentRequestDTO

java.lang.Object

org.broadleafcommerce.common.payment.dto.PaymentRequestDTO

public class PaymentRequestDTO
extends Object

A DTO that is comprised of all the information that is sent to a Payment Gateway to complete a transaction. This DTO uses a modified builder pattern in order to provide an easy way of constructing the request. You can construct a DTO using the following notation:

IMPORTANT: note that some of the convenience methods generate a new instance of the object. (e.g. billTo, shipTo, etc...) So, if you need to modify the shipping or billing information after you have invoked requestDTO.shipTo()..., use the getShipTo() method to append more information. Otherwise, you will overwrite the shipping information with a new instance.

      PaymentRequestDTO requestDTO = new PaymentRequestDTO()
          .orderId(referenceNumber)
          .customer()
              .customerId("1")
              .done()
          .shipTo()
              .addressFirstName("Bill")
              .addressLastName("Broadleaf")
              .addressLine1("123 Test Dr.")
              .addressCityLocality("Austin")
              .addressStateRegion("TX")
              .addressPostalCode("78759")
              .done()
          .billTo()
              .addressFirstName("Bill")
              .addressLastName("Broadleaf")
              .addressLine1("123 Test Dr.")
              .addressCityLocality("Austin")
              .addressStateRegion("TX")
              .addressPostalCode("78759")
              .done()
          .shippingTotal("0")
          .taxTotal("0")
          .orderCurrencyCode("USD")
          .orderDescription("My Order Description")
          .orderSubtotal("10.00")
          .transactionTotal("10.00")
          .lineItem()
              .name("My Product")
              .description("My Product Description")
              .shortDescription("My Product Short Description")
              .systemId("1")
              .amount("10.00")
              .quantity("1")
              .itemTotal("10.00")
              .tax("0")
              .total("10.00")
              .done();
 

Author:

Elbert Bautista (elbertbautista)

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	additionalFields
protected AddressDTO<PaymentRequestDTO>	billTo
protected boolean	completeCheckoutOnCallback
protected CreditCardDTO<PaymentRequestDTO>	creditCard
protected GatewayCustomerDTO<PaymentRequestDTO>	customer
protected List<CustomerCreditDTO<PaymentRequestDTO>>	customerCredits
protected PaymentGatewayRequestType	gatewayRequestType
protected List<GiftCardDTO<PaymentRequestDTO>>	giftCards
protected List<LineItemDTO>	lineItems
protected String	orderCurrencyCode
protected String	orderDescription
protected String	orderId
protected String	orderSubtotal
protected PaymentType	paymentType
protected String	shippingTotal
protected AddressDTO<PaymentRequestDTO>	shipTo
protected SubscriptionDTO<PaymentRequestDTO>	subscription
protected String	taxTotal
protected String	transactionTotal

Constructor Summary

Constructors

Constructor	Description
PaymentRequestDTO()

Method Summary

Modifier and Type	Method	Description
PaymentRequestDTO	additionalField(String key, Object value)
AddressDTO<PaymentRequestDTO>	billTo()	You should only call this once, as it will create a new bill to address if called more than once.
boolean	billToPopulated()
PaymentRequestDTO	completeCheckoutOnCallback(boolean completeCheckoutOnCallback)
CreditCardDTO<PaymentRequestDTO>	creditCard()	You should only call this once, as it will create a new credit card if called more than once.
boolean	creditCardPopulated()
GatewayCustomerDTO<PaymentRequestDTO>	customer()	You should only call this once, as it will create a new customer if called more than once.
CustomerCreditDTO<PaymentRequestDTO>	customerCredit()	You should only call this once, as it will create a new gift card if called more than once.
boolean	customerPopulated()
PaymentRequestDTO	gatewayRequestType(PaymentGatewayRequestType gatewayRequestType)
Map<String,Object>	getAdditionalFields()
AddressDTO<PaymentRequestDTO>	getBillTo()
CreditCardDTO<PaymentRequestDTO>	getCreditCard()
GatewayCustomerDTO<PaymentRequestDTO>	getCustomer()
List<CustomerCreditDTO<PaymentRequestDTO>>	getCustomerCredits()
PaymentGatewayRequestType	getGatewayRequestType()
List<GiftCardDTO<PaymentRequestDTO>>	getGiftCards()
List<LineItemDTO>	getLineItems()
String	getOrderCurrencyCode()
String	getOrderDescription()
String	getOrderId()
String	getOrderSubtotal()
PaymentType	getPaymentType()
String	getShippingTotal()
AddressDTO<PaymentRequestDTO>	getShipTo()
SubscriptionDTO<PaymentRequestDTO>	getSubscription()
String	getTaxTotal()
String	getTransactionTotal()
GiftCardDTO<PaymentRequestDTO>	giftCard()	You should only call this once, as it will create a new gift card if called more than once.
boolean	isCompleteCheckoutOnCallback()
LineItemDTO	lineItem()
PaymentRequestDTO	orderCurrencyCode(String orderCurrencyCode)
PaymentRequestDTO	orderDescription(String orderDescription)
PaymentRequestDTO	orderId(String orderId)
PaymentRequestDTO	orderSubtotal(String orderSubtotal)
PaymentRequestDTO	paymentType(PaymentType paymentType)
PaymentRequestDTO	shippingTotal(String shippingTotal)
AddressDTO<PaymentRequestDTO>	shipTo()	You should only call this once, as it will create a new customer if called more than once.
boolean	shipToPopulated()
SubscriptionDTO<PaymentRequestDTO>	subscription()	You should only call this once, as it will create a new subscription if called more than once.
boolean	subscriptionPopulated()
PaymentRequestDTO	taxTotal(String taxTotal)
PaymentRequestDTO	transactionTotal(String transactionTotal)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

customer

protected GatewayCustomerDTO<PaymentRequestDTO> customer

shipTo

protected AddressDTO<PaymentRequestDTO> shipTo

billTo

protected AddressDTO<PaymentRequestDTO> billTo

creditCard

protected CreditCardDTO<PaymentRequestDTO> creditCard

subscription

protected SubscriptionDTO<PaymentRequestDTO> subscription

giftCards

protected List<GiftCardDTO<PaymentRequestDTO>> giftCards

customerCredits

protected List<CustomerCreditDTO<PaymentRequestDTO>> customerCredits

lineItems

protected List<LineItemDTO> lineItems

additionalFields

protected Map<String,Object> additionalFields

orderId

protected String orderId

orderCurrencyCode

protected String orderCurrencyCode

orderDescription

protected String orderDescription

orderSubtotal

protected String orderSubtotal

shippingTotal

protected String shippingTotal

taxTotal

protected String taxTotal

transactionTotal

protected String transactionTotal

paymentType

protected PaymentType paymentType

gatewayRequestType

protected PaymentGatewayRequestType gatewayRequestType

completeCheckoutOnCallback

protected boolean completeCheckoutOnCallback

Constructor Details

PaymentRequestDTO

public PaymentRequestDTO()

Method Details

customer

public GatewayCustomerDTO<PaymentRequestDTO> customer()

You should only call this once, as it will create a new customer if called more than once. Use the getter if you need to append more information later.

creditCard

public CreditCardDTO<PaymentRequestDTO> creditCard()

You should only call this once, as it will create a new credit card if called more than once. Use the getter if you need to append more information later.

subscription

public SubscriptionDTO<PaymentRequestDTO> subscription()

You should only call this once, as it will create a new subscription if called more than once. Use the getter if you need to append more information later.

shipTo

public AddressDTO<PaymentRequestDTO> shipTo()

You should only call this once, as it will create a new customer if called more than once. Use the getter if you need to append more information later.

billTo

public AddressDTO<PaymentRequestDTO> billTo()

You should only call this once, as it will create a new bill to address if called more than once. Use the getter if you need to append more information later.

giftCard

public GiftCardDTO<PaymentRequestDTO> giftCard()

You should only call this once, as it will create a new gift card if called more than once. Use the getter if you need to append more information later.

customerCredit

public CustomerCreditDTO<PaymentRequestDTO> customerCredit()

You should only call this once, as it will create a new gift card if called more than once. Use the getter if you need to append more information later.

lineItem

public LineItemDTO lineItem()

additionalField

public PaymentRequestDTO additionalField(String key,
 Object value)

orderId

public PaymentRequestDTO orderId(String orderId)

orderCurrencyCode

public PaymentRequestDTO orderCurrencyCode(String orderCurrencyCode)

orderDescription

public PaymentRequestDTO orderDescription(String orderDescription)

orderSubtotal

public PaymentRequestDTO orderSubtotal(String orderSubtotal)

shippingTotal

public PaymentRequestDTO shippingTotal(String shippingTotal)

taxTotal

public PaymentRequestDTO taxTotal(String taxTotal)

transactionTotal

public PaymentRequestDTO transactionTotal(String transactionTotal)

paymentType

public PaymentRequestDTO paymentType(PaymentType paymentType)

gatewayRequestType

public PaymentRequestDTO gatewayRequestType(PaymentGatewayRequestType gatewayRequestType)

completeCheckoutOnCallback

public PaymentRequestDTO completeCheckoutOnCallback(boolean completeCheckoutOnCallback)

getLineItems

public List<LineItemDTO> getLineItems()

getGiftCards

public List<GiftCardDTO<PaymentRequestDTO>> getGiftCards()

getCustomerCredits

public List<CustomerCreditDTO<PaymentRequestDTO>> getCustomerCredits()

getShipTo

public AddressDTO<PaymentRequestDTO> getShipTo()

getBillTo

public AddressDTO<PaymentRequestDTO> getBillTo()

getCreditCard

public CreditCardDTO<PaymentRequestDTO> getCreditCard()

getSubscription

public SubscriptionDTO<PaymentRequestDTO> getSubscription()

getCustomer

public GatewayCustomerDTO<PaymentRequestDTO> getCustomer()

getAdditionalFields

public Map<String,Object> getAdditionalFields()

getOrderId

public String getOrderId()

getOrderCurrencyCode

public String getOrderCurrencyCode()

getOrderDescription

public String getOrderDescription()

getOrderSubtotal

public String getOrderSubtotal()

getShippingTotal

public String getShippingTotal()

getTaxTotal

public String getTaxTotal()

getTransactionTotal

public String getTransactionTotal()

getPaymentType

public PaymentType getPaymentType()

getGatewayRequestType

public PaymentGatewayRequestType getGatewayRequestType()

isCompleteCheckoutOnCallback

public boolean isCompleteCheckoutOnCallback()

shipToPopulated

public boolean shipToPopulated()

billToPopulated

public boolean billToPopulated()

creditCardPopulated

public boolean creditCardPopulated()

customerPopulated

public boolean customerPopulated()

subscriptionPopulated

public boolean subscriptionPopulated()