de.hybris.platform.acceleratorfacades.payment

Interface PaymentFacade

All Known Subinterfaces:

CommerceWebServicesPaymentFacade

All Known Implementing Classes:

DefaultCommerceWebServicesPaymentFacade, DefaultPaymentFacade

public interface PaymentFacade

HOP/SOP facade interface. Service is responsible for getting all necessary information required to build request and .. response from the implemented hosted order page or silent order post provider.

Method Summary

Modifier and Type	Method and Description
PaymentData	beginHopCreateSubscription(java.lang.String responseUrl, java.lang.String merchantCallbackUrl) Gets the Hosted Order Page request data which includes all data required to create a subscription (customer profile).
PaymentData	beginSopCreateSubscription(java.lang.String responseUrl, java.lang.String merchantCallbackUrl) Gets the Silent Order Post request data which includes all data required to create a subscription (customer profile).
PaymentSubscriptionResultData	completeHopCreateSubscription(java.util.Map<java.lang.String,java.lang.String> parameters, boolean saveInAccount) Called to create a subscription internally with the result parameters obtained from the provider's Hosted Order Page.
PaymentSubscriptionResultData	completeSopCreateSubscription(java.util.Map<java.lang.String,java.lang.String> parameters, boolean saveInAccount) Called to create a subscription internally with the result parameters obtained from the provider's Silent Order Post.
PaymentSubscriptionResultData	completeSopCreateSubscription(java.util.Map<java.lang.String,java.lang.String> parameters, boolean saveInAccount, boolean defaultPayment) Called to create a subscription internally with the result parameters obtained from the provider's Silent Order Post.

Method Detail

beginHopCreateSubscription

PaymentData beginHopCreateSubscription(java.lang.String responseUrl,
                                       java.lang.String merchantCallbackUrl)

Gets the Hosted Order Page request data which includes all data required to create a subscription (customer profile).

Parameters:

responseUrl - - requires a HostedOrderPageRequest object containing all the request data.

merchantCallbackUrl - - The URL of the MerchantCallbackController used by the Provider to send validation responses.

Returns:

a PaymentData object which contains all data required to create a subscription.

beginSopCreateSubscription

PaymentData beginSopCreateSubscription(java.lang.String responseUrl,
                                       java.lang.String merchantCallbackUrl)

Gets the Silent Order Post request data which includes all data required to create a subscription (customer profile).

Parameters:

responseUrl - - requires a HostedOrderPageRequest object containing all the request data.

merchantCallbackUrl - - The URL of the MerchantCallbackController used by the Provider to send validation responses.

Returns:

a PaymentData object which contains all data required to create a subscription.

completeHopCreateSubscription

PaymentSubscriptionResultData completeHopCreateSubscription(java.util.Map<java.lang.String,java.lang.String> parameters,
                                                            boolean saveInAccount)

Called to create a subscription internally with the result parameters obtained from the provider's Hosted Order Page.

Parameters:

parameters - - a Map of key-value paired Strings with the result data returned from the HOP/SOP response.

saveInAccount - - a Flag to tell if the PaymentInfo created should saved to the account. During guest checkout the Anonymous user should not hav the PaymentInfos assigned

Returns:

- a CCPaymentInfoData object representing the subscription created by the HOP/SOP response.

completeSopCreateSubscription

PaymentSubscriptionResultData completeSopCreateSubscription(java.util.Map<java.lang.String,java.lang.String> parameters,
                                                            boolean saveInAccount)

Called to create a subscription internally with the result parameters obtained from the provider's Silent Order Post.

Parameters:

parameters - - a Map of key-value paired Strings with the result data returned from the HOP/SOP response.

saveInAccount - - a Flag to tell if the PaymentInfo created should saved to the account. During guest checkout the Anonymous user should not hav the PaymentInfos assigned

Returns:

- a CCPaymentInfoData object representing the subscription created by the HOP/SOP response.

completeSopCreateSubscription

PaymentSubscriptionResultData completeSopCreateSubscription(java.util.Map<java.lang.String,java.lang.String> parameters,
                                                            boolean saveInAccount,
                                                            boolean defaultPayment)

Called to create a subscription internally with the result parameters obtained from the provider's Silent Order Post.

Parameters:

parameters - - a Map of key-value paired Strings with the result data returned from the HOP/SOP response.

saveInAccount - - a Flag to tell if the PaymentInfo created should saved to the account. During guest checkout the Anonymous user should not hav the PaymentInfos assigned

defaultPayment - - a flag to tell whether the created PaymentInfo should be made default or not

Returns:

- a CCPaymentInfoData object representing the subscription created by the HOP/SOP response.