Package com.broadleafcommerce.paymentgateway.service

Interface PaymentGatewaySavedPaymentMethodService

All Superinterfaces:

PaymentGatewayTypeAware

public interface PaymentGatewaySavedPaymentMethodService
extends PaymentGatewayTypeAware

This service is responsible for interacting with the payment gateway for the saved payment methods.

Author:

Dima Myroniuk (dmyroniuk)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	exchangeSingleUseTokenIfApplicable(Map<String,String> paymentMethodProperties, String tenantId, String applicationId)	Exchanges the short-lived (typically single-use) payment token for a long-lived, multi-use token.

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

getGatewayType

Method Detail

exchangeSingleUseTokenIfApplicable

Map<String,String> exchangeSingleUseTokenIfApplicable(Map<String,String> paymentMethodProperties,
                                                            @Nullable
                                                            String tenantId,
                                                            @Nullable
                                                            String applicationId)
                                                     throws ExchangeSingleUseTokenException

Exchanges the short-lived (typically single-use) payment token for a long-lived, multi-use token.

Parameters:

paymentMethodProperties - the map that contains the single-use payment token. This map shouldn't be modified.

tenantId - the id for the current tenant

applicationId - the id for the current application

Returns:

the map that contains the multi-use payment token

Throws:

ExchangeSingleUseTokenException - when an error occurred during token exchanging