de.hybris.platform.integration.cis.subscription.service

Interface CisSubscriptionService

All Known Implementing Classes:

DefaultCisSubscriptionService

public interface CisSubscriptionService

Service called from the facade layer which delegates requests from the client to the CIS server

Method Summary

Modifier and Type	Method and Description
ResponseEntity	cancelSubscription(java.lang.String cisClientRef, java.lang.String merchantSubscriptionId, java.lang.String effectiveFrom) Cancels an existing subscription
ResponseEntity	changeSubscriptionState(java.lang.String cisClientRef, CisSubscriptionChangeStateRequest subscriptionChangeStateRequest) This methods calls the CIS server in order to change the status of an existing subscription
ResponseEntity	createCustomerProfile(java.lang.String cisClientRef, CisSubscriptionProfileRequest createAccountRequest) The methods calls the CIS server in order to create a customer profile.
ResponseEntity	createSubscription(java.lang.String cisClientRef, CisSubscriptionCreateRequest createSubscriptionRequest) This methods calls the CIS server so that informations about the order can be delegated to a billing provider to create a subscription
ResponseEntity	finalizeTransaction(java.lang.String cisClientRef, CisSubscriptionSessionFinalizeRequest finalizeRequest) Calls the CIS Server in order to finalize the Web Session
ResponseEntity	getBillingActivityDetail(java.lang.String cisClientRef, java.lang.String billingActivityId) Returns the billing activity detail for the given id.
ResponseEntity	getBillingActivityList(java.lang.String cisClientRef, java.lang.String subscriptionId, java.util.Date fromDate, java.util.Date toDate) Returns the billing activity list for the given subscription optionally filtered by date.
ResponseEntity	getCustomerProfile(java.lang.String cisClientRef, java.lang.String merchantAccountId) The methods calls the CIS server in order to retrieve a customer's profile data (including subscriptions).
ResponseEntity	hpfUrl(java.lang.String cisClientRef) Retrieves the URL for the silent order page
ResponseEntity	initializeTransaction(java.lang.String cisClientRef, CisSubscriptionSessionInitRequest initRequest) Calls the CIS Server in order to initialize the Web Session
ResponseEntity	processPayNow(java.lang.String cisClientRef, CisSubscriptionPayNowRequest payNowRequest) Calls the CIS Service to process the paynow prices of an order at the payment provider
ResponseEntity	replacePaymentMethod(java.lang.String cisClientRef, java.lang.String merchantSubscriptionId, java.lang.String merchantPaymentMethodId, java.lang.String effectiveFrom) This methods calls the CIS server in order to replace the payment method for an existing subscription with another (existing) payment method.
ResponseEntity	updatePaymentMethod(java.lang.String cisClientRef, CisPaymentMethodUpdateRequest updatePaymentRequest) This methods calls the CIS server in order to perform changes on an existing payment method.
ResponseEntity	updateProfile(java.lang.String cisClientRef, CisSubscriptionProfileRequest profileRequest) Updates a customer account by calling the SBG API method with updated profile data and a existing merchant account id
ResponseEntity	updateSubscription(java.lang.String cisClientRef, CisSubscriptionUpdateRequest subscriptionUpdateRequest) This methods calls the CIS server in order to update an existing subscription
ResponseEntity	updateSubscription(java.lang.String cisClientRef, java.lang.String subscriptionId, boolean force, CisSubscriptionUpdateAction updateAction)
ResponseEntity	upgradeSubscription(java.lang.String cisClientRef, CisSubscriptionUpgradeRequest subscriptionUpgradeRequest) This methods calls the CIS server in order to upgrade an existing subscription

Method Detail

createCustomerProfile

ResponseEntity createCustomerProfile(java.lang.String cisClientRef,
                                     CisSubscriptionProfileRequest createAccountRequest)

The methods calls the CIS server in order to create a customer profile.

Parameters:

cisClientRef - String

createAccountRequest - CisSubscriptionProfileRequest

Returns:

result object from the CIS server

Since:

SBG API 5.2

updateProfile

ResponseEntity updateProfile(java.lang.String cisClientRef,
                             CisSubscriptionProfileRequest profileRequest)

Updates a customer account by calling the SBG API method with updated profile data and a existing merchant account id

Parameters:

cisClientRef - String

profileRequest - CisSubscriptionProfileRequest

Returns:

result object from the CIS server

createSubscription

ResponseEntity createSubscription(java.lang.String cisClientRef,
                                  CisSubscriptionCreateRequest createSubscriptionRequest)

This methods calls the CIS server so that informations about the order can be delegated to a billing provider to create a subscription

Parameters:

cisClientRef - String

createSubscriptionRequest - CisSubscriptionCreateRequest

Returns:

result object from the CIS server

Since:

SBG API 5.2

replacePaymentMethod

ResponseEntity replacePaymentMethod(java.lang.String cisClientRef,
                                    java.lang.String merchantSubscriptionId,
                                    java.lang.String merchantPaymentMethodId,
                                    java.lang.String effectiveFrom)

This methods calls the CIS server in order to replace the payment method for an existing subscription with another (existing) payment method.

Parameters:

cisClientRef - String

merchantSubscriptionId - id of the subscription to be updated String

merchantPaymentMethodId - id of the substituting payment method String

effectiveFrom - when the new payment method should be effective String

Returns:

result object from the CIS server

processPayNow

ResponseEntity processPayNow(java.lang.String cisClientRef,
                             CisSubscriptionPayNowRequest payNowRequest)

Calls the CIS Service to process the paynow prices of an order at the payment provider

Parameters:

cisClientRef - String

payNowRequest - CisSubscriptionPayNowRequest

Returns:

result object from the CIS server

initializeTransaction

ResponseEntity initializeTransaction(java.lang.String cisClientRef,
                                     CisSubscriptionSessionInitRequest initRequest)

Calls the CIS Server in order to initialize the Web Session

Parameters:

cisClientRef - String

initRequest - CisSubscriptionSessionInitRequest

Returns:

result object from the CIS server

finalizeTransaction

ResponseEntity finalizeTransaction(java.lang.String cisClientRef,
                                   CisSubscriptionSessionFinalizeRequest finalizeRequest)

Calls the CIS Server in order to finalize the Web Session

Parameters:

cisClientRef - String

finalizeRequest - CisSubscriptionSessionFinalizeRequest

Returns:

result object from the CIS server

hpfUrl

ResponseEntity hpfUrl(java.lang.String cisClientRef)

Retrieves the URL for the silent order page

Parameters:

cisClientRef - String

Returns:

url as String

updatePaymentMethod

ResponseEntity updatePaymentMethod(java.lang.String cisClientRef,
                                   CisPaymentMethodUpdateRequest updatePaymentRequest)

This methods calls the CIS server in order to perform changes on an existing payment method.

Parameters:

cisClientRef - String

updatePaymentRequest - CisPaymentMethodUpdateRequest

Returns:

result object from the CIS server

cancelSubscription

ResponseEntity cancelSubscription(java.lang.String cisClientRef,
                                  java.lang.String merchantSubscriptionId,
                                  java.lang.String effectiveFrom)

Cancels an existing subscription

Parameters:

cisClientRef - String

merchantSubscriptionId - String

effectiveFrom - String

Returns:

result object from the CIS server

Since:

SBG API 5.2

updateSubscription

ResponseEntity updateSubscription(java.lang.String cisClientRef,
                                  java.lang.String subscriptionId,
                                  boolean force,
                                  CisSubscriptionUpdateAction updateAction)

Parameters:

cisClientRef - String

subscriptionId - String

force - boolean flag set in request

updateAction - CisSubscriptionUpdateAction

Returns:

result object from the CIS server

getCustomerProfile

ResponseEntity getCustomerProfile(java.lang.String cisClientRef,
                                  java.lang.String merchantAccountId)

The methods calls the CIS server in order to retrieve a customer's profile data (including subscriptions).

Parameters:

cisClientRef - String

merchantAccountId - String

Returns:

result object from the CIS server

upgradeSubscription

ResponseEntity upgradeSubscription(java.lang.String cisClientRef,
                                   CisSubscriptionUpgradeRequest subscriptionUpgradeRequest)

This methods calls the CIS server in order to upgrade an existing subscription

Parameters:

cisClientRef - String

subscriptionUpgradeRequest - CisSubscriptionUpgradeRequest

Returns:

result object from the CIS server

updateSubscription

ResponseEntity updateSubscription(java.lang.String cisClientRef,
                                  CisSubscriptionUpdateRequest subscriptionUpdateRequest)

This methods calls the CIS server in order to update an existing subscription

Parameters:

cisClientRef - String

subscriptionUpdateRequest - CisSubscriptionUpdateRequest

Returns:

result object from the CIS server

changeSubscriptionState

ResponseEntity changeSubscriptionState(java.lang.String cisClientRef,
                                       CisSubscriptionChangeStateRequest subscriptionChangeStateRequest)

This methods calls the CIS server in order to change the status of an existing subscription

Parameters:

cisClientRef - String

subscriptionChangeStateRequest - CisSubscriptionChangeStateRequest

Returns:

result object from the CIS server

getBillingActivityList

ResponseEntity getBillingActivityList(java.lang.String cisClientRef,
                                      java.lang.String subscriptionId,
                                      java.util.Date fromDate,
                                      java.util.Date toDate)

Returns the billing activity list for the given subscription optionally filtered by date.

Parameters:

cisClientRef - String

subscriptionId - String

fromDate - String

toDate - String

Returns:

result object from the CIS server

getBillingActivityDetail

ResponseEntity getBillingActivityDetail(java.lang.String cisClientRef,
                                        java.lang.String billingActivityId)

Returns the billing activity detail for the given id.

Parameters:

cisClientRef - String

billingActivityId - String

Returns:

result object from the CIS server