Uses of Class
org.broadleafcommerce.common.payment.dto.PaymentRequestDTO

Packages that use PaymentRequestDTO

Package	Description
org.broadleafcommerce.common.payment.dto
org.broadleafcommerce.common.payment.service
org.broadleafcommerce.common.web.payment.processor
org.broadleafcommerce.core.checkout.service.gateway
org.broadleafcommerce.core.checkout.service.strategy
org.broadleafcommerce.core.payment.service
org.broadleafcommerce.core.web.expression.checkout
org.broadleafcommerce.core.web.payment.service

Uses of PaymentRequestDTO in org.broadleafcommerce.common.payment.dto

Fields in org.broadleafcommerce.common.payment.dto declared as PaymentRequestDTO

Modifier and Type	Field	Description
protected PaymentRequestDTO	LineItemDTO.parent

Fields in org.broadleafcommerce.common.payment.dto with type parameters of type PaymentRequestDTO

Modifier and Type	Field	Description
protected AddressDTO<PaymentRequestDTO>	PaymentRequestDTO.billTo
protected CreditCardDTO<PaymentRequestDTO>	PaymentRequestDTO.creditCard
protected GatewayCustomerDTO<PaymentRequestDTO>	PaymentRequestDTO.customer
protected List<CustomerCreditDTO<PaymentRequestDTO>>	PaymentRequestDTO.customerCredits
protected List<GiftCardDTO<PaymentRequestDTO>>	PaymentRequestDTO.giftCards
protected AddressDTO<PaymentRequestDTO>	PaymentRequestDTO.shipTo
protected SubscriptionDTO<PaymentRequestDTO>	PaymentRequestDTO.subscription

Methods in org.broadleafcommerce.common.payment.dto that return PaymentRequestDTO

Modifier and Type	Method	Description
PaymentRequestDTO	PaymentRequestDTO.additionalField(String key, Object value)
PaymentRequestDTO	PaymentRequestDTO.completeCheckoutOnCallback(boolean completeCheckoutOnCallback)
PaymentRequestDTO	LineItemDTO.done()
PaymentRequestDTO	PaymentRequestDTO.gatewayRequestType(PaymentGatewayRequestType gatewayRequestType)
PaymentRequestDTO	PaymentRequestDTO.orderCurrencyCode(String orderCurrencyCode)
PaymentRequestDTO	PaymentRequestDTO.orderDescription(String orderDescription)
PaymentRequestDTO	PaymentRequestDTO.orderId(String orderId)
PaymentRequestDTO	PaymentRequestDTO.orderSubtotal(String orderSubtotal)
PaymentRequestDTO	PaymentRequestDTO.paymentType(PaymentType paymentType)
PaymentRequestDTO	PaymentRequestDTO.shippingTotal(String shippingTotal)
PaymentRequestDTO	PaymentRequestDTO.taxTotal(String taxTotal)
PaymentRequestDTO	PaymentRequestDTO.transactionTotal(String transactionTotal)

Methods in org.broadleafcommerce.common.payment.dto that return types with arguments of type PaymentRequestDTO

Modifier and Type	Method	Description
AddressDTO<PaymentRequestDTO>	PaymentRequestDTO.billTo()	You should only call this once, as it will create a new bill to address if called more than once.
CreditCardDTO<PaymentRequestDTO>	PaymentRequestDTO.creditCard()	You should only call this once, as it will create a new credit card if called more than once.
GatewayCustomerDTO<PaymentRequestDTO>	PaymentRequestDTO.customer()	You should only call this once, as it will create a new customer if called more than once.
CustomerCreditDTO<PaymentRequestDTO>	PaymentRequestDTO.customerCredit()	You should only call this once, as it will create a new gift card if called more than once.
AddressDTO<PaymentRequestDTO>	PaymentRequestDTO.getBillTo()
CreditCardDTO<PaymentRequestDTO>	PaymentRequestDTO.getCreditCard()
GatewayCustomerDTO<PaymentRequestDTO>	PaymentRequestDTO.getCustomer()
List<CustomerCreditDTO<PaymentRequestDTO>>	PaymentRequestDTO.getCustomerCredits()
List<GiftCardDTO<PaymentRequestDTO>>	PaymentRequestDTO.getGiftCards()
AddressDTO<PaymentRequestDTO>	PaymentRequestDTO.getShipTo()
SubscriptionDTO<PaymentRequestDTO>	PaymentRequestDTO.getSubscription()
GiftCardDTO<PaymentRequestDTO>	PaymentRequestDTO.giftCard()	You should only call this once, as it will create a new gift card if called more than once.
AddressDTO<PaymentRequestDTO>	PaymentRequestDTO.shipTo()	You should only call this once, as it will create a new customer if called more than once.
SubscriptionDTO<PaymentRequestDTO>	PaymentRequestDTO.subscription()	You should only call this once, as it will create a new subscription if called more than once.

Constructors in org.broadleafcommerce.common.payment.dto with parameters of type PaymentRequestDTO

Modifier	Constructor	Description
	LineItemDTO(PaymentRequestDTO parent)

Uses of PaymentRequestDTO in org.broadleafcommerce.common.payment.service

Methods in org.broadleafcommerce.common.payment.service that return PaymentRequestDTO

Modifier and Type	Method	Description
PaymentRequestDTO	CurrentCustomerPaymentRequestService.getPaymentRequestFromCurrentCustomer()	Returns a PaymentRequestDTO based on all the information from the current customer in the system, like one on threadlocal
PaymentRequestDTO	CurrentOrderPaymentRequestService.getPaymentRequestFromCurrentOrder()	Returns a PaymentRequestDTO based on all the information from the current order in the system, like one on threadlocal

Methods in org.broadleafcommerce.common.payment.service with parameters of type PaymentRequestDTO

Modifier and Type	Method	Description
PaymentResponseDTO	AbstractPaymentGatewayTransactionService.authorize(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PassthroughPaymentTransactionService.authorize(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PaymentGatewayTransactionService.authorize(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	AbstractPaymentGatewayTransactionService.authorizeAndCapture(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PassthroughPaymentTransactionService.authorizeAndCapture(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PaymentGatewayTransactionService.authorizeAndCapture(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	AbstractPaymentGatewaySubscriptionService.cancelGatewaySubscription(PaymentRequestDTO requestDTO)
PaymentResponseDTO	PaymentGatewaySubscriptionService.cancelGatewaySubscription(PaymentRequestDTO requestDTO)
PaymentResponseDTO	AbstractPaymentGatewayTransactionService.capture(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PassthroughPaymentTransactionService.capture(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PaymentGatewayTransactionService.capture(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	AbstractPaymentGatewayTransactionConfirmationService.confirmTransaction(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PaymentGatewayTransactionConfirmationService.confirmTransaction(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	AbstractPaymentGatewayTransparentRedirectService.createAuthorizeAndCaptureForm(PaymentRequestDTO requestDTO)
PaymentResponseDTO	PaymentGatewayTransparentRedirectService.createAuthorizeAndCaptureForm(PaymentRequestDTO requestDTO)
PaymentResponseDTO	AbstractPaymentGatewayTransparentRedirectService.createAuthorizeForm(PaymentRequestDTO requestDTO)
PaymentResponseDTO	PaymentGatewayTransparentRedirectService.createAuthorizeForm(PaymentRequestDTO requestDTO)
PaymentResponseDTO	AbstractPaymentGatewayTransparentRedirectService.createCustomerPaymentTokenForm(PaymentRequestDTO requestDTO)
PaymentResponseDTO	PaymentGatewayTransparentRedirectService.createCustomerPaymentTokenForm(PaymentRequestDTO requestDTO)
PaymentResponseDTO	AbstractPaymentGatewayCreditCardService.createGatewayCreditCard(PaymentRequestDTO requestDTO)
PaymentResponseDTO	PaymentGatewayCreditCardService.createGatewayCreditCard(PaymentRequestDTO requestDTO)
PaymentResponseDTO	AbstractPaymentGatewayCustomerService.createGatewayCustomer(PaymentRequestDTO requestDTO)
PaymentResponseDTO	PaymentGatewayCustomerService.createGatewayCustomer(PaymentRequestDTO requestDTO)
PaymentResponseDTO	AbstractPaymentGatewaySubscriptionService.createGatewaySubscription(PaymentRequestDTO requestDTO)
PaymentResponseDTO	PaymentGatewaySubscriptionService.createGatewaySubscription(PaymentRequestDTO requestDTO)
PaymentResponseDTO	AbstractPaymentGatewayCreditCardService.deleteGatewayCreditCard(PaymentRequestDTO requestDTO)
PaymentResponseDTO	PaymentGatewayCreditCardService.deleteGatewayCreditCard(PaymentRequestDTO requestDTO)
PaymentResponseDTO	AbstractPaymentGatewayCustomerService.deleteGatewayCustomer(PaymentRequestDTO requestDTO)
PaymentResponseDTO	PaymentGatewayCustomerService.deleteGatewayCustomer(PaymentRequestDTO requestDTO)
PaymentResponseDTO	AbstractPaymentGatewayReportingService.findDetailsByTransaction(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PaymentGatewayReportingService.findDetailsByTransaction(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	AbstractPaymentGatewayClientTokenService.generateClientToken(PaymentRequestDTO requestDTO)
PaymentResponseDTO	PaymentGatewayClientTokenService.generateClientToken(PaymentRequestDTO requestDTO)
PaymentResponseDTO	AbstractPaymentGatewayTransactionService.refund(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PassthroughPaymentTransactionService.refund(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PaymentGatewayTransactionService.refund(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	AbstractPaymentGatewayHostedService.requestHostedEndpoint(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PaymentGatewayHostedService.requestHostedEndpoint(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	AbstractPaymentGatewayFraudService.requestPayerAuthentication(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PaymentGatewayFraudService.requestPayerAuthentication(PaymentRequestDTO paymentRequestDTO)	Certain Gateways integrate with Visa's Verified by Visa and MasterCard's SecureCode API If the buyer is enrolled in such a service, we will need to redirect the buyer's browser to the ACS ( Access Control Server, eg. users' bank) for verification.
PaymentResponseDTO	AbstractPaymentGatewayTransactionService.reverseAuthorize(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PassthroughPaymentTransactionService.reverseAuthorize(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PaymentGatewayTransactionService.reverseAuthorize(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	AbstractPaymentGatewayRollbackService.rollbackAuthorize(PaymentRequestDTO transactionToBeRolledBack)
PaymentResponseDTO	PaymentGatewayRollbackService.rollbackAuthorize(PaymentRequestDTO transactionToBeRolledBack)
PaymentResponseDTO	AbstractPaymentGatewayRollbackService.rollbackAuthorizeAndCapture(PaymentRequestDTO transactionToBeRolledBack)
PaymentResponseDTO	PaymentGatewayRollbackService.rollbackAuthorizeAndCapture(PaymentRequestDTO transactionToBeRolledBack)
PaymentResponseDTO	AbstractPaymentGatewayRollbackService.rollbackCapture(PaymentRequestDTO transactionToBeRolledBack)
PaymentResponseDTO	PaymentGatewayRollbackService.rollbackCapture(PaymentRequestDTO transactionToBeRolledBack)
PaymentResponseDTO	AbstractPaymentGatewayRollbackService.rollbackRefund(PaymentRequestDTO transactionToBeRolledBack)
PaymentResponseDTO	PaymentGatewayRollbackService.rollbackRefund(PaymentRequestDTO transactionToBeRolledBack)
PaymentResponseDTO	AbstractPaymentGatewayTransparentRedirectService.updateCustomerPaymentTokenForm(PaymentRequestDTO requestDTO)
PaymentResponseDTO	PaymentGatewayTransparentRedirectService.updateCustomerPaymentTokenForm(PaymentRequestDTO requestDTO)
PaymentResponseDTO	AbstractPaymentGatewayCreditCardService.updateGatewayCreditCard(PaymentRequestDTO requestDTO)
PaymentResponseDTO	PaymentGatewayCreditCardService.updateGatewayCreditCard(PaymentRequestDTO requestDTO)
PaymentResponseDTO	AbstractPaymentGatewayCustomerService.updateGatewayCustomer(PaymentRequestDTO requestDTO)
PaymentResponseDTO	PaymentGatewayCustomerService.updateGatewayCustomer(PaymentRequestDTO requestDTO)
PaymentResponseDTO	AbstractPaymentGatewaySubscriptionService.updateGatewaySubscription(PaymentRequestDTO requestDTO)
PaymentResponseDTO	PaymentGatewaySubscriptionService.updateGatewaySubscription(PaymentRequestDTO requestDTO)
PaymentResponseDTO	AbstractPaymentGatewayTransactionService.voidPayment(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PassthroughPaymentTransactionService.voidPayment(PaymentRequestDTO paymentRequestDTO)
PaymentResponseDTO	PaymentGatewayTransactionService.voidPayment(PaymentRequestDTO paymentRequestDTO)

Uses of PaymentRequestDTO in org.broadleafcommerce.common.web.payment.processor

Methods in org.broadleafcommerce.common.web.payment.processor with parameters of type PaymentRequestDTO

Modifier and Type	Method	Description
ExtensionResultStatusType	AbstractTRCreditCardExtensionHandler.createTransparentRedirectForm(Map<String,Map<String,String>> formParameters, PaymentRequestDTO requestDTO, Map<String,String> configurationSettings)
ExtensionResultStatusType	TRCreditCardExtensionHandler.createTransparentRedirectForm(Map<String,Map<String,String>> formParameters, PaymentRequestDTO requestDTO, Map<String,String> configurationSettings)	The implementing modules should take into consideration the passed in configuration settings map and call their implementing TransparentRedirectService to generate either an Authorize or Authorize and Capture Form.
protected void	AbstractTRCreditCardExtensionHandler.overrideCustomerPaymentReturnURLs(PaymentRequestDTO requestDTO, PaymentResponseDTO responseDTO)	If the request contains information about an override return URL, use the one specified on the request dto.

Uses of PaymentRequestDTO in org.broadleafcommerce.core.checkout.service.gateway

Methods in org.broadleafcommerce.core.checkout.service.gateway with parameters of type PaymentRequestDTO

Modifier and Type	Method	Description
PaymentResponseDTO	PassthroughPaymentRollbackServiceImpl.rollbackAuthorize(PaymentRequestDTO transactionToBeRolledBack)
PaymentResponseDTO	PassthroughPaymentRollbackServiceImpl.rollbackAuthorizeAndCapture(PaymentRequestDTO transactionToBeRolledBack)
PaymentResponseDTO	PassthroughPaymentRollbackServiceImpl.rollbackCapture(PaymentRequestDTO transactionToBeRolledBack)
PaymentResponseDTO	PassthroughPaymentRollbackServiceImpl.rollbackRefund(PaymentRequestDTO transactionToBeRolledBack)

Uses of PaymentRequestDTO in org.broadleafcommerce.core.checkout.service.strategy

Methods in org.broadleafcommerce.core.checkout.service.strategy with parameters of type PaymentRequestDTO

Modifier and Type	Method	Description
protected PaymentResponseDTO	OrderPaymentConfirmationStrategyImpl.constructPendingTransaction(PaymentType paymentType, PaymentGatewayType gatewayType, PaymentRequestDTO confirmationRequest)
protected void	OrderPaymentConfirmationStrategyImpl.populateBillingAddressOnRequest(PaymentRequestDTO requestDTO, OrderPayment payment)
protected void	OrderPaymentConfirmationStrategyImpl.populateCreditCardOnRequest(PaymentRequestDTO requestDTO, OrderPayment payment)
protected void	OrderPaymentConfirmationStrategyImpl.populateCustomerOnRequest(PaymentRequestDTO requestDTO, OrderPayment payment)
protected void	OrderPaymentConfirmationStrategyImpl.populateShippingAddressOnRequest(PaymentRequestDTO requestDTO, OrderPayment payment)

Uses of PaymentRequestDTO in org.broadleafcommerce.core.payment.service

Methods in org.broadleafcommerce.core.payment.service that return PaymentRequestDTO

Modifier and Type	Method	Description
PaymentRequestDTO	PaymentRequestDTOService.populateCustomerInfo(PaymentRequestDTO requestDTO, Customer customer)	Uses customer information to populate the customer() object
PaymentRequestDTO	PaymentRequestDTOService.populateCustomerInfo(PaymentRequestDTO requestDTO, Customer customer, String defaultEmailAddress)	Uses customer information to populate the customer() object
PaymentRequestDTO	PaymentRequestDTOServiceImpl.populateCustomerInfo(PaymentRequestDTO requestDTO, Customer customer)
PaymentRequestDTO	PaymentRequestDTOServiceImpl.populateCustomerInfo(PaymentRequestDTO requestDTO, Customer customer, String defaultEmailAddress)
PaymentRequestDTO	OrderToPaymentRequestDTOService.translateOrder(Order order)	This translates an Order into a PaymentRequestDTO.
PaymentRequestDTO	OrderToPaymentRequestDTOServiceImpl.translateOrder(Order order)
PaymentRequestDTO	OrderToPaymentRequestDTOService.translatePaymentTransaction(Money transactionAmount, PaymentTransaction paymentTransaction)	Utilizes the PaymentTransaction.getAdditionalFields() map to populate necessary request parameters on the resulting PaymentRequestDTO.
PaymentRequestDTO	OrderToPaymentRequestDTOService.translatePaymentTransaction(Money transactionAmount, PaymentTransaction paymentTransaction, boolean autoCalculateFinalPaymentTotals)	Important: As of 4.0.1-GA+, there is a requirement to automatically populate the transaction amount on the DTO only if coming from a "checkout payment flow".
PaymentRequestDTO	OrderToPaymentRequestDTOServiceImpl.translatePaymentTransaction(Money transactionAmount, PaymentTransaction paymentTransaction)
PaymentRequestDTO	OrderToPaymentRequestDTOServiceImpl.translatePaymentTransaction(Money transactionAmount, PaymentTransaction paymentTransaction, boolean autoCalculateFinalPaymentTotals)

Methods in org.broadleafcommerce.core.payment.service with parameters of type PaymentRequestDTO

Modifier and Type	Method	Description
void	OrderToPaymentRequestDTOService.populateBillTo(Order order, PaymentRequestDTO requestDTO)	Uses billing information on the Order to populate the billTo() object
void	OrderToPaymentRequestDTOServiceImpl.populateBillTo(Order order, PaymentRequestDTO requestDTO)
void	OrderToPaymentRequestDTOService.populateCustomerInfo(Order order, PaymentRequestDTO requestDTO)	Uses customer information on the Order to populate the customer() object
void	OrderToPaymentRequestDTOServiceImpl.populateCustomerInfo(Order order, PaymentRequestDTO requestDTO)
PaymentRequestDTO	PaymentRequestDTOService.populateCustomerInfo(PaymentRequestDTO requestDTO, Customer customer)	Uses customer information to populate the customer() object
PaymentRequestDTO	PaymentRequestDTOService.populateCustomerInfo(PaymentRequestDTO requestDTO, Customer customer, String defaultEmailAddress)	Uses customer information to populate the customer() object
PaymentRequestDTO	PaymentRequestDTOServiceImpl.populateCustomerInfo(PaymentRequestDTO requestDTO, Customer customer)
PaymentRequestDTO	PaymentRequestDTOServiceImpl.populateCustomerInfo(PaymentRequestDTO requestDTO, Customer customer, String defaultEmailAddress)
void	OrderToPaymentRequestDTOService.populateDefaultLineItemsAndSubtotal(Order order, PaymentRequestDTO requestDTO)	Uses order information to populate various line item and subtotal information on the order
void	OrderToPaymentRequestDTOServiceImpl.populateDefaultLineItemsAndSubtotal(Order order, PaymentRequestDTO requestDTO)	IMPORTANT:
void	OrderToPaymentRequestDTOService.populateShipTo(Order order, PaymentRequestDTO requestDTO)	Uses the first shippable fulfillment group to populate the shipTo() object
void	OrderToPaymentRequestDTOServiceImpl.populateShipTo(Order order, PaymentRequestDTO requestDTO)	Uses the first shippable fulfillment group to populate the shipTo() object
void	OrderToPaymentRequestDTOService.populateTotals(Order order, PaymentRequestDTO requestDTO)	Uses total information on the Order to populate the transactionTotal(String)()} taxTotal(String)()} shippingTotal(String)()} orderCurrencyCode(String)()}
void	OrderToPaymentRequestDTOServiceImpl.populateTotals(Order order, PaymentRequestDTO requestDTO)

Method parameters in org.broadleafcommerce.core.payment.service with type arguments of type PaymentRequestDTO

Modifier and Type	Method	Description
protected void	OrderToPaymentRequestDTOServiceImpl.populateAddressInfo(AddressDTO<PaymentRequestDTO> dto, Address address)

Uses of PaymentRequestDTO in org.broadleafcommerce.core.web.expression.checkout

Methods in org.broadleafcommerce.core.web.expression.checkout that return PaymentRequestDTO

Modifier and Type	Method	Description
PaymentRequestDTO	PaymentMethodVariableExpression.getPaymentRequestDTO()

Uses of PaymentRequestDTO in org.broadleafcommerce.core.web.payment.service

Methods in org.broadleafcommerce.core.web.payment.service that return PaymentRequestDTO

Modifier and Type	Method	Description
PaymentRequestDTO	DefaultCurrentCustomerPaymentRequestService.getPaymentRequestFromCurrentCustomer()
PaymentRequestDTO	DefaultCurrentOrderPaymentRequestService.getPaymentRequestFromCurrentOrder()