Package com.broadleafcommerce.paymenttransaction.web.endpoint

Class TransactionExecutionEndpoint

java.lang.Object

com.broadleafcommerce.paymenttransaction.web.endpoint.TransactionExecutionEndpoint

@FrameworkRestController
@FrameworkMapping("/payments")
@DataRouteByKey("paymentTransaction")
public class TransactionExecutionEndpoint
extends Object

Author:

Chris Kittrell (ckittrell)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
TransactionExecutionEndpoint(PaymentService<Payment> paymentService, PaymentVersionValidationService paymentVersionValidationService, PaymentAccessValidationService paymentAccessValidationService, TransactionExecutionService transactionExecutionService)

Method Summary

Modifier and Type	Method	Description
TransactionExecutionResponse	executeAuthorize(String paymentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Integer paymentVersion, PaymentLockInfo paymentLockInfo, TransactionExecutionRequest request)
TransactionExecutionResponse	executeAuthorizeAndCapture(String paymentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Integer paymentVersion, PaymentLockInfo paymentLockInfo, TransactionExecutionRequest request)
TransactionExecutionResponse	executeCapture(String paymentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Integer paymentVersion, PaymentLockInfo paymentLockInfo, TransactionExecutionRequest request)
TransactionExecutionResponse	executeDetachedCredit(String paymentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Integer paymentVersion, PaymentLockInfo paymentLockInfo, TransactionExecutionRequest request)
TransactionExecutionResponse	executeRefund(String paymentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Integer paymentVersion, PaymentLockInfo paymentLockInfo, TransactionExecutionRequest request)
TransactionExecutionResponse	executeReverseAuthorize(String paymentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Integer paymentVersion, PaymentLockInfo paymentLockInfo, TransactionExecutionRequest request)
protected PaymentAccessValidationService	getPaymentAccessValidationService()
protected PaymentService<Payment>	getPaymentService()
protected PaymentVersionValidationService	getPaymentVersionValidationService()
protected TransactionExecutionService	getTransactionExecutionService()
protected TransactionResultService	getTransactionResultService()
TransactionExecutionResponse	lookupSavedPaymentMethodTransactionResult(String paymentId, String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
PaymentSummary	recordTransactionResults(String paymentId, Map<String,Object> transactionResults, Integer paymentVersion, CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	setTransactionResultService(TransactionResultService transactionResultService)

Methods inherited from class java.lang.Object

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

Field Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

Constructor Details

TransactionExecutionEndpoint

public TransactionExecutionEndpoint(PaymentService<Payment> paymentService,
 PaymentVersionValidationService paymentVersionValidationService,
 PaymentAccessValidationService paymentAccessValidationService,
 TransactionExecutionService transactionExecutionService)

Method Details

executeAuthorize

@FrameworkPostMapping(value="/{id}/authorize",
                      consumes="application/json")
@Policy(permissionRoots="EXECUTE_AUTHORIZE")
public TransactionExecutionResponse executeAuthorize(@PathVariable("id")
 String paymentId,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 Integer paymentVersion,
 PaymentLockInfo paymentLockInfo,
 @RequestBody
 TransactionExecutionRequest request)

executeReverseAuthorize

@FrameworkPostMapping(value="/{id}/reverse-authorize",
                      consumes="application/json")
@Policy(permissionRoots="EXECUTE_REVERSE_AUTHORIZE")
public TransactionExecutionResponse executeReverseAuthorize(@PathVariable("id")
 String paymentId,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 Integer paymentVersion,
 PaymentLockInfo paymentLockInfo,
 @RequestBody
 TransactionExecutionRequest request)

executeAuthorizeAndCapture

@FrameworkPostMapping(value="/{id}/authorize-and-capture",
                      consumes="application/json")
@Policy(permissionRoots="EXECUTE_AUTHORIZE_AND_CAPTURE")
public TransactionExecutionResponse executeAuthorizeAndCapture(@PathVariable("id")
 String paymentId,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 Integer paymentVersion,
 PaymentLockInfo paymentLockInfo,
 @RequestBody
 TransactionExecutionRequest request)

executeCapture

@FrameworkPostMapping(value="/{id}/capture",
                      consumes="application/json")
@Policy(permissionRoots="EXECUTE_CAPTURE")
public TransactionExecutionResponse executeCapture(@PathVariable("id")
 String paymentId,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 Integer paymentVersion,
 PaymentLockInfo paymentLockInfo,
 @RequestBody
 TransactionExecutionRequest request)

executeRefund

@FrameworkPostMapping(value="/{id}/refund",
                      consumes="application/json")
@Policy(permissionRoots="EXECUTE_REFUND")
public TransactionExecutionResponse executeRefund(@PathVariable("id")
 String paymentId,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 Integer paymentVersion,
 PaymentLockInfo paymentLockInfo,
 @RequestBody
 TransactionExecutionRequest request)

lookupSavedPaymentMethodTransactionResult

@FrameworkGetMapping("/{id}/refund/{requestId}")
@Policy(permissionRoots="REFUND_TRANSACTION_RESULTS")
public TransactionExecutionResponse lookupSavedPaymentMethodTransactionResult(@PathVariable("id")
 String paymentId,
 @PathVariable("requestId")
 String requestId,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

executeDetachedCredit

@FrameworkPostMapping(value="/{id}/detached-credit",
                      consumes="application/json")
@Policy(permissionRoots="EXECUTE_DETACHED_CREDIT")
public TransactionExecutionResponse executeDetachedCredit(@PathVariable("id")
 String paymentId,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 Integer paymentVersion,
 PaymentLockInfo paymentLockInfo,
 @RequestBody
 TransactionExecutionRequest request)

recordTransactionResults

@FrameworkPostMapping(value="/{id}/record-transaction-results",
                      consumes="application/json")
@Policy(permissionRoots="RECORD_TRANSACTION_RESULTS")
public PaymentSummary recordTransactionResults(@PathVariable("id")
 String paymentId,
 @RequestBody
 Map<String,Object> transactionResults,
 Integer paymentVersion,
 CustomerRef customerRef,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getPaymentService

protected PaymentService<Payment> getPaymentService()

getPaymentVersionValidationService

protected PaymentVersionValidationService getPaymentVersionValidationService()

getPaymentAccessValidationService

protected PaymentAccessValidationService getPaymentAccessValidationService()

getTransactionExecutionService

protected TransactionExecutionService getTransactionExecutionService()

setTransactionResultService

@Autowired
public void setTransactionResultService(TransactionResultService transactionResultService)

getTransactionResultService

protected TransactionResultService getTransactionResultService()