Package com.broadleafcommerce.paymentgateway.service

Interface PaymentGatewayPaymentModificationService

All Superinterfaces:

PaymentGatewayTypeAware

public interface PaymentGatewayPaymentModificationService
extends PaymentGatewayTypeAware

This service is responsible for interacting with the payment gateway to modify a payment's paymentMethodProperties.

Author:

Dima Myroniuk (dmyroniuk)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	modifyPaymentMethodProperties(Map<String,String> paymentMethodProperties, String applicationId, String tenantId)	Modify the given paymentMethodProperties for alternative values used by the gateway.

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

getGatewayType

Method Detail

modifyPaymentMethodProperties

Map<String,String> modifyPaymentMethodProperties(Map<String,String> paymentMethodProperties,
                                                       @Nullable
                                                       String applicationId,
                                                       @Nullable
                                                       String tenantId)

Modify the given paymentMethodProperties for alternative values used by the gateway. In most cases, this involves swapping a provided payment representation for a different style of representation. For example, swapping a digital wallet token for the payment gateway's token.

Parameters:

paymentMethodProperties - the payment method properties

applicationId - the application id

tenantId - the tenant id

Returns:

the map that contains the exchanged payment token