Package com.broadleafcommerce.paymentgateway.service

Interface PaymentGatewayPaymentSummaryService

All Superinterfaces:

PaymentGatewayTypeAware

public interface PaymentGatewayPaymentSummaryService
extends PaymentGatewayTypeAware

This service used for modifying PaymentSummary objects as they're built based on a PaymentTransactionServices Payment.

Author:

Chris Kittrell (ckittrell)

Method Summary

Modifier and Type	Method	Description
default NextAction	buildNextActionFromPayment(PaymentInfo paymentInfo, String applicationId, String tenantId)	Builds a NextAction based on the provided PaymentInfo.

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

getGatewayType

Method Details

buildNextActionFromPayment

@Nullable
default NextAction buildNextActionFromPayment(PaymentInfo paymentInfo,
 @Nullable
 String applicationId,
 @Nullable
 String tenantId)

Builds a NextAction based on the provided PaymentInfo. The assumption is that this method is only used if the related payment does not have any transactions. Therefore, this NextAction serves as a default action.

Parameters:

paymentInfo - the information about payment * @param applicationId the application id * @param tenantId the tenant id

Returns:

a NextAction based on the provided PaymentInfo, or null if a next action cannot/should not be declared for the payment.