Package com.commercetools.payment.service

Interface PaymentAdapterService

All Known Implementing Classes:

PaymentAdapterServiceImpl

public interface PaymentAdapterService

Defines the methods that the shop could call to handle its payment. The shop should never directly call a PaymentServiceProvider implementation. Created by mgatz on 7/18/16.

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletionStage<PaymentCreationResult>	createPayment(CreatePaymentData data)	Creates a new payment object at the CTP and thereby starts a new payment transaction workflow.
java.util.concurrent.CompletionStage<PaymentTransactionCreationResult>	createPaymentTransaction(CreatePaymentTransactionData data)	Create and handle a new payment transaction for the payment with the passed reference.
java.util.List<PaymentServiceProvider>	findAllPaymentServiceProviders()	Find all payment services (implementing PaymentServiceProvider on the classpath and return a list of their service entry points.
java.util.List<io.sphere.sdk.payments.PaymentMethodInfo>	findAvailablePaymentMethods()	Get a list of available payment methods collected from all available PaymentServiceProvider instances findAllPaymentServiceProviders()
java.util.List<io.sphere.sdk.payments.PaymentMethodInfo>	findAvailablePaymentMethods(java.util.function.Function<java.util.List<io.sphere.sdk.payments.PaymentMethodInfo>,java.util.List<io.sphere.sdk.payments.PaymentMethodInfo>> filter)	Get a filtered list of available payment methods collected from all available PaymentServiceProvider instances findAllPaymentServiceProviders()
java.util.Optional<io.sphere.sdk.payments.PaymentMethodInfo>	getPaymentMethodInfo(java.lang.String interfaceId, java.lang.String method)	Get the full PaymentMethodInfo object from the configuration.
static PaymentAdapterService	of()

Method Detail

of

static PaymentAdapterService of()

Returns:

the default instance of the payment adapter service

findAllPaymentServiceProviders

java.util.List<PaymentServiceProvider> findAllPaymentServiceProviders()

Find all payment services (implementing PaymentServiceProvider on the classpath and return a list of their service entry points.

Returns:

list of payment service implementation entry points

findAvailablePaymentMethods

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

Get a list of available payment methods collected from all available PaymentServiceProvider instances findAllPaymentServiceProviders()

Returns:

list of payment method objects

findAvailablePaymentMethods

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

Get a filtered list of available payment methods collected from all available PaymentServiceProvider instances findAllPaymentServiceProviders()

Parameters:

filter - the filterfunction that will be applied

Returns:

list of payment method objects

createPayment

java.util.concurrent.CompletionStage<PaymentCreationResult> createPayment(CreatePaymentData data)

Creates a new payment object at the CTP and thereby starts a new payment transaction workflow.

Parameters:

data - the wrapper object for all possibly needed data

Returns:

CompletionStage of PaymentCreationResult with the result of data payment creation

createPaymentTransaction

java.util.concurrent.CompletionStage<PaymentTransactionCreationResult> createPaymentTransaction(CreatePaymentTransactionData data)

Create and handle a new payment transaction for the payment with the passed reference.

Parameters:

data - the wrapper object for all possibly needed data

Returns:

CompletionStage of PaymentTransactionCreationResult with the result of data transaction creation.

getPaymentMethodInfo

java.util.Optional<io.sphere.sdk.payments.PaymentMethodInfo> getPaymentMethodInfo(java.lang.String interfaceId,
                                                                                  java.lang.String method)

Get the full PaymentMethodInfo object from the configuration.

Parameters:

interfaceId - payment interface id name

method - payment method name

Returns:

Optional of PaymentMethodInfo if such method for such interface exists.