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 firstPaymentGatewayConfigurationthat matches the givenPaymentGatewayType.getCustomerService(String gatewayType) Returns the firstPaymentGatewayCustomerServicethat matches the givenPaymentGatewayType.getHostedService(String gatewayType) Returns the firstPaymentGatewayHostedServicethat matches the givenPaymentGatewayType.getPaymentModificationService(String gatewayType) Returns the implementation ofPaymentGatewayPaymentModificationServicefor the specified gateway type.getPaymentValidator(String gatewayType) Returns the firstPaymentGatewayPaymentValidatorthat matches the givenPaymentGatewayType.getReportingService(String gatewayType) Returns the firstPaymentGatewayReportingServicethat matches the givenPaymentGatewayType.getRollbackService(String gatewayType) Returns the firstPaymentGatewayRollbackServicethat matches the givenPaymentGatewayType.getSavedPaymentMethodService(String gatewayType) Returns the implementation ofPaymentGatewaySavedPaymentMethodServicefor the specified gateway type or null.getSavedPaymentMethodWebhookHandler(String gatewayType) Returns the firstPaymentGatewaySavedPaymentMethodWebhookHandlerthat matches the givenPaymentGatewayType.getTransactionLookupService(String gatewayType) Returns the implementation ofPaymentGatewayTransactionLookupServicefor the specified gateway type.getTransactionResponseService(String gatewayType) Returns the firstPaymentGatewayTransactionResponseServicethat matches the givenPaymentGatewayType.getTransactionResponseValidator(String gatewayType) Returns the firstPaymentGatewayTransactionResponseValidatorthat matches the givenPaymentGatewayType.getTransactionService(String gatewayType) Returns the firstPaymentGatewayTransactionServicethat matches the givenPaymentGatewayType.getWebhookHandler(String gatewayType) Returns the firstPaymentGatewayWebhookHandlerthat matches the givenPaymentGatewayType.
-
Method Details
-
getConfiguration
Returns the firstPaymentGatewayConfigurationthat matches the givenPaymentGatewayType.- Parameters:
gatewayType- a String representation of thePaymentGatewayType- Throws:
UnsupportedOperationException- if there is no resource for the givenPaymentGatewayType.
-
getTransactionService
Returns the firstPaymentGatewayTransactionServicethat matches the givenPaymentGatewayType.- Parameters:
gatewayType- a String representation of thePaymentGatewayType- Throws:
UnsupportedOperationException- if there is no resource for the givenPaymentGatewayType.
-
getRollbackService
Returns the firstPaymentGatewayRollbackServicethat matches the givenPaymentGatewayType.- Parameters:
gatewayType- a String representation of thePaymentGatewayType- Throws:
UnsupportedOperationException- if there is no resource for the givenPaymentGatewayType.
-
getWebhookHandler
Returns the firstPaymentGatewayWebhookHandlerthat 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 firstPaymentGatewaySavedPaymentMethodWebhookHandlerthat matches the givenPaymentGatewayType.- Parameters:
gatewayType- a String representation of thePaymentGatewayType- Throws:
UnsupportedOperationException- if there is no resource for the givenPaymentGatewayType.
-
getReportingService
Returns the firstPaymentGatewayReportingServicethat matches the givenPaymentGatewayType.- Parameters:
gatewayType- a String representation of thePaymentGatewayType- Throws:
UnsupportedOperationException- if there is no resource for the givenPaymentGatewayType.
-
getCustomerService
Returns the firstPaymentGatewayCustomerServicethat matches the givenPaymentGatewayType.- Parameters:
gatewayType- a String representation of thePaymentGatewayType- Throws:
UnsupportedOperationException- if there is no resource for the givenPaymentGatewayType.
-
getHostedService
Returns the firstPaymentGatewayHostedServicethat matches the givenPaymentGatewayType.- Parameters:
gatewayType- a String representation of thePaymentGatewayType- Throws:
UnsupportedOperationException- if there is no resource for the givenPaymentGatewayType.
-
getPaymentValidator
Returns the firstPaymentGatewayPaymentValidatorthat matches the givenPaymentGatewayType.- Parameters:
gatewayType- a String representation of thePaymentGatewayType- Throws:
UnsupportedOperationException- if there is no resource for the givenPaymentGatewayType.
-
getTransactionResponseService
Returns the firstPaymentGatewayTransactionResponseServicethat matches the givenPaymentGatewayType.- Parameters:
gatewayType- a String representation of thePaymentGatewayType- Throws:
UnsupportedOperationException- if there is no resource for the givenPaymentGatewayType.
-
getTransactionResponseValidator
Returns the firstPaymentGatewayTransactionResponseValidatorthat matches the givenPaymentGatewayType.- Parameters:
gatewayType- a String representation of thePaymentGatewayType- Throws:
UnsupportedOperationException- if there is no resource for the givenPaymentGatewayType.
-
getSavedPaymentMethodService
Returns the implementation ofPaymentGatewaySavedPaymentMethodServicefor the specified gateway type or null.- Parameters:
gatewayType- thePaymentGatewayTyperelated to implementing resource- Returns:
- the implementation of
PaymentGatewaySavedPaymentMethodServicefor the specified gateway type or null
-
get3DSTransactionLookupService
@Deprecated PaymentGateway3DSTransactionLookupService get3DSTransactionLookupService(String gatewayType) Deprecated.in favor ofgetTransactionLookupService(String)Returns the implementation ofPaymentGateway3DSTransactionLookupServicefor the specified gateway type.- Parameters:
gatewayType- thePaymentGatewayTyperelated to implementing resource- Returns:
- the implementation of
PaymentGateway3DSTransactionLookupServicefor the specified gateway type
-
getPaymentModificationService
@Nullable PaymentGatewayPaymentModificationService getPaymentModificationService(String gatewayType) Returns the implementation ofPaymentGatewayPaymentModificationServicefor the specified gateway type.- Parameters:
gatewayType- thePaymentGatewayTyperelated to implementing resource- Returns:
- the implementation of
PaymentGatewayPaymentModificationServicefor the specified gateway type
-
getTransactionLookupService
Returns the implementation ofPaymentGatewayTransactionLookupServicefor the specified gateway type.- Parameters:
gatewayType- thePaymentGatewayTyperelated to implementing resource- Returns:
- the implementation of
PaymentGatewayTransactionLookupServicefor the specified gateway type
-
getTransactionLookupService(String)