com.broadleafcommerce.cartoperation.service.payment

Interface PaymentTransactionService

All Known Implementing Classes:

DefaultPaymentTransactionService

public interface PaymentTransactionService

Service responsible for the creation of PaymentTransactions & the recording of PaymentResponse results on the PaymentTransaction

Author:

Chris Kittrell (ckittrell)

Method Summary

Modifier and Type	Method and Description
org.apache.commons.lang3.tuple.Triple<com.broadleafcommerce.cart.client.domain.Cart,com.broadleafcommerce.order.common.domain.Payment,com.broadleafcommerce.order.common.domain.PaymentTransaction>	createPaymentTransaction(com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.order.common.domain.Payment payment, com.broadleafcommerce.paymentgateway.domain.enums.TransactionType transactionType, javax.money.MonetaryAmount amount, String requestId, com.broadleafcommerce.order.common.domain.PaymentTransaction parentTransaction, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Creates a pending PaymentTransaction & saves it to the provided cart payment.
default org.apache.commons.lang3.tuple.Triple<com.broadleafcommerce.cart.client.domain.Cart,com.broadleafcommerce.order.common.domain.Payment,com.broadleafcommerce.order.common.domain.PaymentTransaction>	createPaymentTransaction(com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.order.common.domain.Payment payment, com.broadleafcommerce.paymentgateway.domain.enums.TransactionType transactionType, String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Creates a pending PaymentTransaction & saves it to the provided cart payment.
default org.apache.commons.lang3.tuple.Triple<com.broadleafcommerce.cart.client.domain.Cart,com.broadleafcommerce.order.common.domain.Payment,com.broadleafcommerce.order.common.domain.PaymentTransaction>	createPaymentTransaction(com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.order.common.domain.Payment payment, com.broadleafcommerce.paymentgateway.domain.enums.TransactionType transactionType, String requestId, com.broadleafcommerce.order.common.domain.PaymentTransaction parentTransaction, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Creates a pending PaymentTransaction & saves it to the provided cart payment.
com.broadleafcommerce.cart.client.domain.Cart	recordTransactionResponse(com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.order.common.domain.Payment payment, com.broadleafcommerce.order.common.domain.PaymentTransaction transaction, com.broadleafcommerce.paymentgateway.domain.PaymentResponse response, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Interprets the payment gateway's PaymentResponse & records the results on the given Payment & PaymentTransaction.

Method Detail

createPaymentTransaction

default org.apache.commons.lang3.tuple.Triple<com.broadleafcommerce.cart.client.domain.Cart,com.broadleafcommerce.order.common.domain.Payment,com.broadleafcommerce.order.common.domain.PaymentTransaction> createPaymentTransaction(com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                                                                                                                                                                                     com.broadleafcommerce.order.common.domain.Payment payment,
                                                                                                                                                                                                                                     com.broadleafcommerce.paymentgateway.domain.enums.TransactionType transactionType,
                                                                                                                                                                                                                                     String requestId,
                                                                                                                                                                                                                                     @Nullable
                                                                                                                                                                                                                                     com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Creates a pending PaymentTransaction & saves it to the provided cart payment. This transaction is meant to record our intention to send a request to the payment gateway & it creates a PaymentTransaction.getTransactionReferenceId() which would also be passed to the gateway so that they two can be linked. Note: since an amount is not specified, the transaction amount will be pulled from Payment.getAmount()

Parameters:

cart - the owning cart

payment - The payment that should own this transaction

transactionType - The type of transaction that should be created

requestId - the id representing the customer's request to confirm their payments

contextInfo - Context information around sandbox and multitenant state.

Returns:

The updated/created cart, payment, & paymentTransaction

createPaymentTransaction

default org.apache.commons.lang3.tuple.Triple<com.broadleafcommerce.cart.client.domain.Cart,com.broadleafcommerce.order.common.domain.Payment,com.broadleafcommerce.order.common.domain.PaymentTransaction> createPaymentTransaction(com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                                                                                                                                                                                     com.broadleafcommerce.order.common.domain.Payment payment,
                                                                                                                                                                                                                                     com.broadleafcommerce.paymentgateway.domain.enums.TransactionType transactionType,
                                                                                                                                                                                                                                     String requestId,
                                                                                                                                                                                                                                     @Nullable
                                                                                                                                                                                                                                     com.broadleafcommerce.order.common.domain.PaymentTransaction parentTransaction,
                                                                                                                                                                                                                                     @Nullable
                                                                                                                                                                                                                                     com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Creates a pending PaymentTransaction & saves it to the provided cart payment. This transaction is meant to record our intention to send a request to the payment gateway & it creates a PaymentTransaction.getTransactionReferenceId() which would also be passed to the gateway so that they two can be linked. Note: since an amount is not specified, the transaction amount will be pulled from Payment.getAmount()

Parameters:

cart - the owning cart

payment - The payment that should own this transaction

transactionType - The type of transaction that should be created

requestId - the id representing the customer's request to confirm their payments

parentTransaction - A related transaction that this created transaction should link to

contextInfo - Context information around sandbox and multitenant state.

Returns:

The updated/created cart, payment, & paymentTransaction

createPaymentTransaction

org.apache.commons.lang3.tuple.Triple<com.broadleafcommerce.cart.client.domain.Cart,com.broadleafcommerce.order.common.domain.Payment,com.broadleafcommerce.order.common.domain.PaymentTransaction> createPaymentTransaction(com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                                                                                                                                                                             com.broadleafcommerce.order.common.domain.Payment payment,
                                                                                                                                                                                                                             com.broadleafcommerce.paymentgateway.domain.enums.TransactionType transactionType,
                                                                                                                                                                                                                             javax.money.MonetaryAmount amount,
                                                                                                                                                                                                                             String requestId,
                                                                                                                                                                                                                             @Nullable
                                                                                                                                                                                                                             com.broadleafcommerce.order.common.domain.PaymentTransaction parentTransaction,
                                                                                                                                                                                                                             @Nullable
                                                                                                                                                                                                                             com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Creates a pending PaymentTransaction & saves it to the provided cart payment. This transaction is meant to record our intention to send a request to the payment gateway & it creates a PaymentTransaction.getTransactionReferenceId() which would also be passed to the gateway so that they two can be linked.

Parameters:

cart - the owning cart

payment - The payment that should own this transaction

transactionType - The type of transaction that should be created

amount - The monetary amount related to this transaction

requestId - the id representing the customer's request to confirm their payments

parentTransaction - A related transaction that this created transaction should link to

contextInfo - Context information around sandbox and multitenant state.

Returns:

The updated/created cart, payment, & paymentTransaction

recordTransactionResponse

com.broadleafcommerce.cart.client.domain.Cart recordTransactionResponse(com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                        com.broadleafcommerce.order.common.domain.Payment payment,
                                                                        com.broadleafcommerce.order.common.domain.PaymentTransaction transaction,
                                                                        com.broadleafcommerce.paymentgateway.domain.PaymentResponse response,
                                                                        @Nullable
                                                                        com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Interprets the payment gateway's PaymentResponse & records the results on the given Payment & PaymentTransaction. Note: if the transaction failed, then the payment should also be archived so that it can no longer contribute to a successful checkout

Parameters:

cart - the owning cart

payment - the payment that we intended to authorize

transaction - the transaction that is to hold the results of the transaction

response - the payment gateway's response to our authorization attempt

contextInfo - Context information around sandbox and multitenant state.

Returns:

the updated cart, including the authorization results

Throws:

com.broadleafcommerce.paymentgateway.service.exception.PaymentException - thrown if the response represents a failed authorization