Package com.commercetools.payment.domain

Interface PaymentServiceProvider

All Known Implementing Classes:

NoPaymentServiceProvider, PayonePaymentServiceProvider

public interface PaymentServiceProvider

A payment service provider provides functions that can be used to handle payment related tasks in a PSP specific way.

Method Summary

Modifier and Type	Method	Description
default java.lang.UnsupportedOperationException	createUnsupportedMethodException(java.lang.String methodId)
java.util.List<io.sphere.sdk.payments.PaymentMethodInfo>	getAvailablePaymentMethods()
java.util.List<io.sphere.sdk.payments.PaymentMethodInfo>	getAvailablePaymentMethods(java.util.function.Function<java.util.List<io.sphere.sdk.payments.PaymentMethodInfo>,java.util.List<io.sphere.sdk.payments.PaymentMethodInfo>> filter)	Create a (filtered) list of payment methods.
java.lang.String	getId()
java.util.function.Function<CreatePaymentData,java.util.concurrent.CompletionStage<PaymentCreationResult>>	provideCreatePaymentHandler(java.lang.String methodId)	Create a function that can create a payment for the passed method Id
java.util.function.Function<CreatePaymentTransactionData,java.util.concurrent.CompletionStage<PaymentTransactionCreationResult>>	provideCreatePaymentTransactionHandler(java.lang.String methodId)	Create a function that can create a payment transaction for a payment object and has the ability to handle overriding of configuration values via given key value pairs.

Method Detail

getId

java.lang.String getId()

Returns:

a unique identifier of the payment service provider

getAvailablePaymentMethods

java.util.List<io.sphere.sdk.payments.PaymentMethodInfo> getAvailablePaymentMethods()

Returns:

an unfiltered list of payment methods this PSP supports

getAvailablePaymentMethods

java.util.List<io.sphere.sdk.payments.PaymentMethodInfo> getAvailablePaymentMethods(@Nullable
                                                                                    java.util.function.Function<java.util.List<io.sphere.sdk.payments.PaymentMethodInfo>,java.util.List<io.sphere.sdk.payments.PaymentMethodInfo>> filter)

Create a (filtered) list of payment methods.

Parameters:

filter - a filter function that can be applied to the whole list of payment methods before returning them

Returns:

a list of payment methods this PSP supports

provideCreatePaymentHandler

java.util.function.Function<CreatePaymentData,java.util.concurrent.CompletionStage<PaymentCreationResult>> provideCreatePaymentHandler(java.lang.String methodId)
                                                                                                                                throws java.lang.UnsupportedOperationException

Create a function that can create a payment for the passed method Id

Parameters:

methodId - the ID of the payment method to be used for the payment object

Returns:

a function method creating the payment object for the passed method Id

Throws:

java.lang.UnsupportedOperationException - if such methodId is not implemented

provideCreatePaymentTransactionHandler

java.util.function.Function<CreatePaymentTransactionData,java.util.concurrent.CompletionStage<PaymentTransactionCreationResult>> provideCreatePaymentTransactionHandler(java.lang.String methodId)
                                                                                                                                                                 throws java.lang.UnsupportedOperationException

Create a function that can create a payment transaction for a payment object and has the ability to handle overriding of configuration values via given key value pairs.

Parameters:

methodId - the ID of the payment method to be used for the payment transaction object

Returns:

a function method creating a payment transaction

Throws:

java.lang.UnsupportedOperationException - if such methodId is not implemented

createUnsupportedMethodException

@Nonnull
default java.lang.UnsupportedOperationException createUnsupportedMethodException(java.lang.String methodId)
                                                                          throws java.lang.UnsupportedOperationException

Throws:

java.lang.UnsupportedOperationException