com.commercetools.payment.utils

Interface PaymentLookupHelper

All Known Implementing Classes:

PaymentLookupHelperImpl

public interface PaymentLookupHelper

Created by mgatz on 7/21/16.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletionStage<java.util.Optional<io.sphere.sdk.payments.Payment>>	findPayment(io.sphere.sdk.carts.Cart cart, java.lang.String pspId, java.lang.String methodId) Find a payment object related to the passed cart using its payment service provider ID and its method ID.
java.util.concurrent.CompletionStage<io.sphere.sdk.payments.Payment>	findPayment(java.lang.String id) Find a payment object using its unique ID.
java.util.concurrent.CompletionStage<CreatePaymentTransactionData>	findPaymentFor(CreatePaymentTransactionData data) Find a payment object for the provided data.
java.util.concurrent.CompletionStage<java.util.Optional<io.sphere.sdk.payments.Payment>>	findPaymentWithoutTransaction(io.sphere.sdk.carts.Cart cart, java.lang.String pspId, java.lang.String methodId) Find a payment object related to the passed cart using its payment service provider ID and its method ID that has no transaction attached.
static PaymentLookupHelper	of(io.sphere.sdk.client.SphereClient client)

Method Detail

of

static PaymentLookupHelper of(io.sphere.sdk.client.SphereClient client)

findPayment

java.util.concurrent.CompletionStage<io.sphere.sdk.payments.Payment> findPayment(java.lang.String id)

Find a payment object using its unique ID.

Parameters:

id - the unique ID of the payment object

Returns:

the payment object if one exists

findPayment

java.util.concurrent.CompletionStage<java.util.Optional<io.sphere.sdk.payments.Payment>> findPayment(io.sphere.sdk.carts.Cart cart,
                                                                                                     java.lang.String pspId,
                                                                                                     java.lang.String methodId)

Find a payment object related to the passed cart using its payment service provider ID and its method ID. If more then one object is found then the newest one (concidering the creationdate) will be returned only.

Parameters:

cart - the cart object to lookup the payment objects attached to

pspId - the payment service provider ID (mapped to "interfaceId" at CTP)

methodId - the payment method ID (mapped to "paymentMethodInfo.paymentInterface" at CTP)

Returns:

the payment object if one exists

findPaymentWithoutTransaction

java.util.concurrent.CompletionStage<java.util.Optional<io.sphere.sdk.payments.Payment>> findPaymentWithoutTransaction(io.sphere.sdk.carts.Cart cart,
                                                                                                                       java.lang.String pspId,
                                                                                                                       java.lang.String methodId)

Find a payment object related to the passed cart using its payment service provider ID and its method ID that has no transaction attached. If more then on object is found then the newest one (concidering the creationdate) will be returned only.

Parameters:

cart - a cart for which a new payment must be created.

pspId - the payment service provider ID (mapped to "interfaceId" at CTP)

methodId - the payment method ID (mapped to "paymentMethodInfo.paymentInterface" at CTP)

Returns:

CompletionStage of optional Payment if found any.

findPaymentFor

java.util.concurrent.CompletionStage<CreatePaymentTransactionData> findPaymentFor(CreatePaymentTransactionData data)

Find a payment object for the provided data.

Parameters:

data - the data holding object

Returns:

the parameter enriched with the payment object