Package com.broadleafcommerce.paymentgateway.service

Interface PaymentGatewayTransactionLookupService

All Superinterfaces:

PaymentGatewayTypeAware

All Known Subinterfaces:

PaymentGateway3DSTransactionLookupService

public interface PaymentGatewayTransactionLookupService
extends PaymentGatewayTypeAware

This service is responsible for interacting with the payment gateway to fetch the payment details. For example, if we need to verify that transactions exist in checkout.

Author:

Sgupta

Method Summary

Modifier and Type	Method	Description
org.apache.commons.lang3.tuple.Pair<TransactionIdentifier,PaymentResponse>	getTransactionDetails(Map<String,String> requestParams, String tenantId, String applicationId)	Returns the payment details.
PaymentResponse	lookupTransactionDetails(TransactionLookupRequest transactionLookupRequest, String tenantId, String applicationId)	Gathers transaction details from the payment gateway.
default void	validateRequestParams(Map<String,String> requestParams)	Deprecated. use validateRequestParams(Map, String, String)
default void	validateRequestParams(Map<String,String> requestParams, String tenantId, String applicationId)	Validates the request parameters

Methods inherited from interface com.broadleafcommerce.paymentgateway.service.PaymentGatewayTypeAware

getGatewayType

Method Details

validateRequestParams

default void validateRequestParams(Map<String,String> requestParams)

Deprecated.

use validateRequestParams(Map, String, String)

validateRequestParams

default void validateRequestParams(Map<String,String> requestParams,
 @Nullable
 String tenantId,
 @Nullable
 String applicationId)

Validates the request parameters

Parameters:

requestParams - the parameters to validate

tenantId - the id for the current tenant

applicationId - the id for the current application

Throws:

InvalidFetchPaymentDetailsParamsException - if the parameters are invalid

getTransactionDetails

org.apache.commons.lang3.tuple.Pair<TransactionIdentifier,PaymentResponse> getTransactionDetails(Map<String,String> requestParams,
 @Nullable
 String tenantId,
 @Nullable
 String applicationId)

Returns the payment details.

Parameters:

requestParams - the gateway-specific parameters on the request. For example, the payment details from Checkout.com will contain "cko-session-id".

tenantId - the id for the current tenant

applicationId - the id for the current application

Returns:

the payment details

Throws:

InvalidGatewayConfigurationException - when the integration is insufficiently configured

TransactionNotFoundException - when the related transaction cannot be found

FetchTransactionResultsException - when an error occurred during fetching of the transaction details

TransactionResultsNotAvailableException - when the transaction results are not yet available

lookupTransactionDetails

PaymentResponse lookupTransactionDetails(TransactionLookupRequest transactionLookupRequest,
 @Nullable
 String tenantId,
 @Nullable
 String applicationId)

Gathers transaction details from the payment gateway.

Parameters:

transactionLookupRequest - the request object including transaction-identifying data

tenantId - the id for the current tenant

applicationId - the id for the current application

Returns:

the payment details

Throws:

InvalidGatewayConfigurationException - when the integration is insufficiently configured

InvalidFetchPaymentDetailsParamsException - when insufficient data is provided to look up the transaction

TransactionNotFoundException - when the related transaction cannot be found

FetchTransactionResultsException - when an error occurred during fetching of the transaction details

TransactionResultsNotAvailableException - when the transaction results are not yet available