Interface PaymentGatewayResourceProvider
- All Known Implementing Classes:
DefaultPaymentGatewayResourceProvider
public interface PaymentGatewayResourceProvider
This represents the main service bus for retrieving payment gateway service implementations to
execute service calls programmatically. Since multiple gateways can be configured for a single
implementation (like PayPal Express and Braintree, or PayPal Express, a credit card module and a
gift card module) this allows you to select between them to perform additional operations on a
payment transaction.
- Author:
- Chris Kittrell (ckittrell)
-
Method Summary
Modifier and TypeMethodDescriptionget3DSTransactionLookupService
(String gatewayType) Deprecated.getConfiguration
(String gatewayType) Returns the firstPaymentGatewayConfiguration
that matches the givenPaymentGatewayType
.getCustomerService
(String gatewayType) Returns the firstPaymentGatewayCustomerService
that matches the givenPaymentGatewayType
.getHostedService
(String gatewayType) Returns the firstPaymentGatewayHostedService
that matches the givenPaymentGatewayType
.getPaymentModificationService
(String gatewayType) Returns the implementation ofPaymentGatewayPaymentModificationService
for the specified gateway type.getPaymentValidator
(String gatewayType) Returns the firstPaymentGatewayPaymentValidator
that matches the givenPaymentGatewayType
.getReportingService
(String gatewayType) Returns the firstPaymentGatewayReportingService
that matches the givenPaymentGatewayType
.getRollbackService
(String gatewayType) Returns the firstPaymentGatewayRollbackService
that matches the givenPaymentGatewayType
.getSavedPaymentMethodService
(String gatewayType) Returns the implementation ofPaymentGatewaySavedPaymentMethodService
for the specified gateway type or null.getSavedPaymentMethodWebhookHandler
(String gatewayType) Returns the firstPaymentGatewaySavedPaymentMethodWebhookHandler
that matches the givenPaymentGatewayType
.getTransactionLookupService
(String gatewayType) Returns the implementation ofPaymentGatewayTransactionLookupService
for the specified gateway type.getTransactionResponseService
(String gatewayType) Returns the firstPaymentGatewayTransactionResponseService
that matches the givenPaymentGatewayType
.getTransactionResponseValidator
(String gatewayType) Returns the firstPaymentGatewayTransactionResponseValidator
that matches the givenPaymentGatewayType
.getTransactionService
(String gatewayType) Returns the firstPaymentGatewayTransactionService
that matches the givenPaymentGatewayType
.getWebhookHandler
(String gatewayType) Returns the firstPaymentGatewayWebhookHandler
that matches the givenPaymentGatewayType
.
-
Method Details
-
getConfiguration
Returns the firstPaymentGatewayConfiguration
that matches the givenPaymentGatewayType
.- Parameters:
gatewayType
- a String representation of thePaymentGatewayType
- Throws:
UnsupportedOperationException
- if there is no resource for the givenPaymentGatewayType
.
-
getTransactionService
Returns the firstPaymentGatewayTransactionService
that matches the givenPaymentGatewayType
.- Parameters:
gatewayType
- a String representation of thePaymentGatewayType
- Throws:
UnsupportedOperationException
- if there is no resource for the givenPaymentGatewayType
.
-
getRollbackService
Returns the firstPaymentGatewayRollbackService
that matches the givenPaymentGatewayType
.- Parameters:
gatewayType
- a String representation of thePaymentGatewayType
- Throws:
UnsupportedOperationException
- if there is no resource for the givenPaymentGatewayType
.
-
getWebhookHandler
Returns the firstPaymentGatewayWebhookHandler
that matches the givenPaymentGatewayType
.- Parameters:
gatewayType
- a String representation of thePaymentGatewayType
- Throws:
UnsupportedOperationException
- if there is no resource for the givenPaymentGatewayType
.
-
getSavedPaymentMethodWebhookHandler
PaymentGatewaySavedPaymentMethodWebhookHandler getSavedPaymentMethodWebhookHandler(String gatewayType) Returns the firstPaymentGatewaySavedPaymentMethodWebhookHandler
that matches the givenPaymentGatewayType
.- Parameters:
gatewayType
- a String representation of thePaymentGatewayType
- Throws:
UnsupportedOperationException
- if there is no resource for the givenPaymentGatewayType
.
-
getReportingService
Returns the firstPaymentGatewayReportingService
that matches the givenPaymentGatewayType
.- Parameters:
gatewayType
- a String representation of thePaymentGatewayType
- Throws:
UnsupportedOperationException
- if there is no resource for the givenPaymentGatewayType
.
-
getCustomerService
Returns the firstPaymentGatewayCustomerService
that matches the givenPaymentGatewayType
.- Parameters:
gatewayType
- a String representation of thePaymentGatewayType
- Throws:
UnsupportedOperationException
- if there is no resource for the givenPaymentGatewayType
.
-
getHostedService
Returns the firstPaymentGatewayHostedService
that matches the givenPaymentGatewayType
.- Parameters:
gatewayType
- a String representation of thePaymentGatewayType
- Throws:
UnsupportedOperationException
- if there is no resource for the givenPaymentGatewayType
.
-
getPaymentValidator
Returns the firstPaymentGatewayPaymentValidator
that matches the givenPaymentGatewayType
.- Parameters:
gatewayType
- a String representation of thePaymentGatewayType
- Throws:
UnsupportedOperationException
- if there is no resource for the givenPaymentGatewayType
.
-
getTransactionResponseService
Returns the firstPaymentGatewayTransactionResponseService
that matches the givenPaymentGatewayType
.- Parameters:
gatewayType
- a String representation of thePaymentGatewayType
- Throws:
UnsupportedOperationException
- if there is no resource for the givenPaymentGatewayType
.
-
getTransactionResponseValidator
Returns the firstPaymentGatewayTransactionResponseValidator
that matches the givenPaymentGatewayType
.- Parameters:
gatewayType
- a String representation of thePaymentGatewayType
- Throws:
UnsupportedOperationException
- if there is no resource for the givenPaymentGatewayType
.
-
getSavedPaymentMethodService
Returns the implementation ofPaymentGatewaySavedPaymentMethodService
for the specified gateway type or null.- Parameters:
gatewayType
- thePaymentGatewayType
related to implementing resource- Returns:
- the implementation of
PaymentGatewaySavedPaymentMethodService
for the specified gateway type or null
-
get3DSTransactionLookupService
@Deprecated PaymentGateway3DSTransactionLookupService get3DSTransactionLookupService(String gatewayType) Deprecated.in favor ofgetTransactionLookupService(String)
Returns the implementation ofPaymentGateway3DSTransactionLookupService
for the specified gateway type.- Parameters:
gatewayType
- thePaymentGatewayType
related to implementing resource- Returns:
- the implementation of
PaymentGateway3DSTransactionLookupService
for the specified gateway type
-
getPaymentModificationService
@Nullable PaymentGatewayPaymentModificationService getPaymentModificationService(String gatewayType) Returns the implementation ofPaymentGatewayPaymentModificationService
for the specified gateway type.- Parameters:
gatewayType
- thePaymentGatewayType
related to implementing resource- Returns:
- the implementation of
PaymentGatewayPaymentModificationService
for the specified gateway type
-
getTransactionLookupService
Returns the implementation ofPaymentGatewayTransactionLookupService
for the specified gateway type.- Parameters:
gatewayType
- thePaymentGatewayType
related to implementing resource- Returns:
- the implementation of
PaymentGatewayTransactionLookupService
for the specified gateway type
-
getTransactionLookupService(String)