de.hybris.platform.payment.impl

Class DefaultPaymentServiceImpl

java.lang.Object

de.hybris.platform.payment.impl.DefaultPaymentServiceImpl

All Implemented Interfaces:

PaymentService

Direct Known Subclasses:

DefaultAlipayPaymentService, DefaultWeChatPayPaymentService

public class DefaultPaymentServiceImpl
extends java.lang.Object
implements PaymentService

Default implementation for PaymentService

Constructor Summary

Constructors

Constructor and Description
DefaultPaymentServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	attachPaymentInfo(PaymentTransactionModel paymentTransactionModel, UserModel userModel, CardInfo cardInfo, java.math.BigDecimal amount) Attaches PaymentInfo to the assigned PaymentTransactionModel instance by using the configured PaymentInfoCreatorStrategy.
PaymentTransactionEntryModel	authorize(OrderModel order, CardInfo card) Deprecated. Since 4.2.2 use any of the other authorize methods
PaymentTransactionEntryModel	authorize(PaymentTransactionModel transaction, java.math.BigDecimal amount, java.util.Currency currency, AddressModel deliveryAddress, AddressModel paymentAddress, CardInfo card) authorize payment note: the code of the assigned payment transaction will be used as code-basecode during the PaymentTransactionEntryModel.CODE code generation process, which represents the main benefit of this method.
PaymentTransactionEntryModel	authorize(PaymentTransactionModel transaction, java.math.BigDecimal amount, java.util.Currency currency, AddressModel deliveryAddress, java.lang.String subscriptionID) authorize payment
PaymentTransactionEntryModel	authorize(PaymentTransactionModel transaction, java.math.BigDecimal amount, java.util.Currency currency, AddressModel deliveryAddress, java.lang.String subscriptionID, java.lang.String paymentprovider) authorize payment note: the code of the assigned payment transaction will be used as code-basecode during the PaymentTransactionEntryModel.CODE code generation process, which represents the main benefit of this method.
PaymentTransactionEntryModel	authorize(java.lang.String merchantTransactionCode, java.math.BigDecimal amount, java.util.Currency currency, AddressModel deliveryAddress, AddressModel paymentAddress, CardInfo card) authorize payment
PaymentTransactionEntryModel	authorize(java.lang.String merchantTransactionCode, java.math.BigDecimal amount, java.util.Currency currency, AddressModel deliveryAddress, java.lang.String subscriptionID) Authorize payment. Status, transaction and request related informations are available via the related PaymentTransactionEntryModel,/ Informations about the related order will be accessible via the referenced PaymentTransactionModel (see: PaymentTransactionEntryModel.getPaymentTransaction() and PaymentTransactionEntryModel.setPaymentTransaction(PaymentTransactionModel)
PaymentTransactionEntryModel	authorize(java.lang.String merchantTransactionCode, java.math.BigDecimal amount, java.util.Currency currency, AddressModel deliveryAddress, java.lang.String subscriptionID, java.lang.String cv2, java.lang.String paymentProvider) authorize payment
protected PaymentTransactionEntryModel	authorizeInternal(PaymentTransactionModel transaction, java.math.BigDecimal amount, java.util.Currency currency, BillingInfo shippingInfo, CardInfo card, java.lang.String subscriptionID, java.lang.String cv2, java.lang.String paymentProvider) ...
PaymentTransactionEntryModel	cancel(PaymentTransactionEntryModel transaction) Cancel payment
PaymentTransactionEntryModel	capture(PaymentTransactionModel transaction) capture payment
protected BillingInfo	createBillingInfo(AddressModel address) address DTO 2 address DTO
protected BillingInfo	createBillingInfo(AddressModel deliveryAddress, AddressModel paymentAddress, CardInfo card) creates the billing info based on the assigned delivery address instance.
NewSubscription	createSubscription(PaymentTransactionModel transaction, AddressModel paymentAddress, CardInfo card) Creates a subscription at the payment provider side and stores sensitive data there.
NewSubscription	createSubscription(java.lang.String merchantTransactionCode, java.lang.String paymentProvider, java.util.Currency currency, AddressModel paymentAddress, CardInfo card) Creates a subscription at the payment provider side and stores sensitive data there.
PaymentTransactionEntryModel	deleteSubscription(java.lang.String merchantTransactionCode, java.lang.String subscriptionID, java.lang.String paymentProvider) Deletes the subscription at the payment provider.
protected CardPaymentService	getCardPaymentService()
protected CommonI18NService	getCommonI18NService()
protected FlexibleSearchService	getFlexibleSearchService()
protected ModelService	getModelService()
java.lang.String	getNewPaymentTransactionEntryCode(PaymentTransactionModel transaction, PaymentTransactionType paymentTransactionType) Generate new merchant transaction code for payment transaction entries based on code for whole transaction
protected PaymentInfoCreatorStrategy	getPaymentInfoCreator()
PaymentTransactionModel	getPaymentTransaction(java.lang.String code) Get PaymentTransactionModel by code
PaymentTransactionEntryModel	getPaymentTransactionEntry(java.lang.String code) Get PaymentTransactionEntryModel by code
PaymentTransactionEntryModel	getSubscriptionData(java.lang.String merchantTransactionCode, java.lang.String subscriptionID, java.lang.String paymentProvider, BillingInfo billingInfo, CardInfo card) Gets the stored card info or payment address
protected TransactionCodeGenerator	getTransactionCodeGenerator()
PaymentTransactionEntryModel	partialCapture(PaymentTransactionModel transaction, java.math.BigDecimal amount) Take a partial capture of authorized transaction
PaymentTransactionEntryModel	refundFollowOn(PaymentTransactionModel transaction, java.math.BigDecimal amount) Refund transaction
PaymentTransactionEntryModel	refundStandalone(StandaloneRefundRequest request) Deprecated. Since 4.2.2 use refundStandalone(String, BigDecimal, Currency, AddressModel, CardInfo) instead
PaymentTransactionEntryModel	refundStandalone(java.lang.String merchantTransactionCode, java.math.BigDecimal amount, java.util.Currency currency, AddressModel paymentAddress, CardInfo card) Refund value to a card (no transaction is obligatory)
PaymentTransactionEntryModel	refundStandalone(java.lang.String merchantTransactionCode, java.math.BigDecimal amount, java.util.Currency currency, AddressModel paymentAddress, CardInfo card, java.lang.String providerName, java.lang.String subscriptionId) Refund value to a card (no transaction is obligatory)
void	setCardPaymentService(CardPaymentService cardPaymentService)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setFlexibleSearchService(FlexibleSearchService flexibleSearchService)
void	setModelService(ModelService modelService)
void	setPaymentInfoCreator(PaymentInfoCreatorStrategy paymentInfoCreator)
void	setTransactionCodeGenerator(TransactionCodeGenerator transactionCodeGenerator)
PaymentTransactionEntryModel	updateSubscription(java.lang.String merchantTransactionCode, java.lang.String subscriptionID, java.lang.String paymentProvider, AddressModel paymentAddress, CardInfo card) Updates the data of the subscription at the payment provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPaymentServiceImpl

public DefaultPaymentServiceImpl()

Method Detail

authorize

public PaymentTransactionEntryModel authorize(java.lang.String merchantTransactionCode,
                                              java.math.BigDecimal amount,
                                              java.util.Currency currency,
                                              AddressModel deliveryAddress,
                                              java.lang.String subscriptionID)

Authorize payment.
Status, transaction and request related informations are available via the related PaymentTransactionEntryModel,/
Informations about the related order will be accessible via the referenced PaymentTransactionModel (see: PaymentTransactionEntryModel.getPaymentTransaction() and PaymentTransactionEntryModel.setPaymentTransaction(PaymentTransactionModel)

Specified by:

authorize in interface PaymentService

Parameters:

merchantTransactionCode - the transaction code. Code of the internally generated PaymentTransactionModel and code-base of the final PaymentTransactionEntryModel.CODE which will be generated by using the injected TransactionCodeGenerator

amount - the amount

currency - the currency

deliveryAddress - the delivery address

subscriptionID - the subscriptionID

Returns:

Payment Transaction Entry

Throws:

AdapterException

authorize

public PaymentTransactionEntryModel authorize(java.lang.String merchantTransactionCode,
                                              java.math.BigDecimal amount,
                                              java.util.Currency currency,
                                              AddressModel deliveryAddress,
                                              java.lang.String subscriptionID,
                                              java.lang.String cv2,
                                              java.lang.String paymentProvider)

Description copied from interface: PaymentService

authorize payment

Specified by:

authorize in interface PaymentService

Parameters:

merchantTransactionCode - the transaction code

amount - the amount

currency - the currency

deliveryAddress - the delivery address (paymentAddress is used if null)

subscriptionID - the subscriptionID

cv2 - card verification value

paymentProvider - code of payment provider

Returns:

Payment Transaction Entry

authorize

public PaymentTransactionEntryModel authorize(java.lang.String merchantTransactionCode,
                                              java.math.BigDecimal amount,
                                              java.util.Currency currency,
                                              AddressModel deliveryAddress,
                                              AddressModel paymentAddress,
                                              CardInfo card)

Description copied from interface: PaymentService

authorize payment

Specified by:

authorize in interface PaymentService

Parameters:

merchantTransactionCode - the transaction code

amount - the amount

currency - the currency

deliveryAddress - the delivery address (paymentAddress is used if null)

paymentAddress - the payment address

card - the card

Returns:

Payment Transaction Entry

authorize

public PaymentTransactionEntryModel authorize(PaymentTransactionModel transaction,
                                              java.math.BigDecimal amount,
                                              java.util.Currency currency,
                                              AddressModel deliveryAddress,
                                              AddressModel paymentAddress,
                                              CardInfo card)

authorize payment
note: the code of the assigned payment transaction will be used as code-basecode during the PaymentTransactionEntryModel.CODE code generation process, which represents the main benefit of this method.

Specified by:

authorize in interface PaymentService

Parameters:

transaction - the payment transaction

amount - the amount

currency - the currency

deliveryAddress - the delivery address

paymentAddress - the payment address

card - the card

Returns:

Payment Transaction Entry

Throws:

AdapterException

authorize

public PaymentTransactionEntryModel authorize(PaymentTransactionModel transaction,
                                              java.math.BigDecimal amount,
                                              java.util.Currency currency,
                                              AddressModel deliveryAddress,
                                              java.lang.String subscriptionID,
                                              java.lang.String paymentprovider)

authorize payment
note: the code of the assigned payment transaction will be used as code-basecode during the PaymentTransactionEntryModel.CODE code generation process, which represents the main benefit of this method.

Specified by:

authorize in interface PaymentService

Parameters:

transaction - the payment transaction

amount - the amount

currency - the currency

deliveryAddress - the delivery address

subscriptionID - will be used for identifying the user profile (see payment tokenization)

paymentprovider - code of payment provider

Returns:

Payment Transaction Entry

Throws:

AdapterException

authorize

public PaymentTransactionEntryModel authorize(PaymentTransactionModel transaction,
                                              java.math.BigDecimal amount,
                                              java.util.Currency currency,
                                              AddressModel deliveryAddress,
                                              java.lang.String subscriptionID)

Description copied from interface: PaymentService

authorize payment

Specified by:

authorize in interface PaymentService

Parameters:

transaction - the payment transaction

amount - the amount

currency - the currency

deliveryAddress - the delivery address (paymentAddress is used if null)

subscriptionID - the subscriptionID

Returns:

Payment Transaction Entry

authorizeInternal

protected PaymentTransactionEntryModel authorizeInternal(PaymentTransactionModel transaction,
                                                         java.math.BigDecimal amount,
                                                         java.util.Currency currency,
                                                         BillingInfo shippingInfo,
                                                         CardInfo card,
                                                         java.lang.String subscriptionID,
                                                         java.lang.String cv2,
                                                         java.lang.String paymentProvider)

... internally used authorization.

Parameters:

transaction - the payment transaction

amount - the amount we ant to authorize

currency - the related currency of the amount

shippingInfo - the shipping info

card - the card info

subscriptionID - will be used for identifying the user profile (see payment tokenization)

Throws:

AdapterException

getNewPaymentTransactionEntryCode

public java.lang.String getNewPaymentTransactionEntryCode(PaymentTransactionModel transaction,
                                                          PaymentTransactionType paymentTransactionType)

Generate new merchant transaction code for payment transaction entries based on code for whole transaction

Specified by:

getNewPaymentTransactionEntryCode in interface PaymentService

Parameters:

transaction - An associated Payment transaction

paymentTransactionType - A type of entry.

Returns:

A new unique code withing a transaction context.

createBillingInfo

protected BillingInfo createBillingInfo(AddressModel deliveryAddress,
                                        AddressModel paymentAddress,
                                        CardInfo card)

creates the billing info based on the assigned delivery address instance. In case the deliveryAddress is null, we will use the billing info of the assigned CardInfo instance.

Parameters:

deliveryAddress - the delivery address

paymentAddress - the payment address

card - the card info

Returns:

the billing info

createBillingInfo

protected BillingInfo createBillingInfo(AddressModel address)

address DTO 2 address DTO

authorize

@Deprecated
public PaymentTransactionEntryModel authorize(OrderModel order,
                                                          CardInfo card)

Deprecated. Since 4.2.2 use any of the other authorize methods

authorize payment. the injected TransactionCodeGenerator will be used for determining the 'merchant transaction code' .

Specified by:

authorize in interface PaymentService

Parameters:

order - the order

card - the card

Returns:

Payment Transaction Entry

Throws:

AdapterException

capture

public PaymentTransactionEntryModel capture(PaymentTransactionModel transaction)

Description copied from interface: PaymentService

capture payment

Specified by:

capture in interface PaymentService

Parameters:

transaction - payment transaction

Returns:

payment transaction entry

cancel

public PaymentTransactionEntryModel cancel(PaymentTransactionEntryModel transaction)

Description copied from interface: PaymentService

Cancel payment

Specified by:

cancel in interface PaymentService

Parameters:

transaction - payment transaction

Returns:

payment transaction entry

refundFollowOn

public PaymentTransactionEntryModel refundFollowOn(PaymentTransactionModel transaction,
                                                   java.math.BigDecimal amount)

Description copied from interface: PaymentService

Refund transaction

Specified by:

refundFollowOn in interface PaymentService

Parameters:

transaction - payment transaction

amount - amount to refund

Returns:

payment transaction entry

refundStandalone

@Deprecated
public PaymentTransactionEntryModel refundStandalone(StandaloneRefundRequest request)

Deprecated. Since 4.2.2 use refundStandalone(String, BigDecimal, Currency, AddressModel, CardInfo) instead

Description copied from interface: PaymentService

Refund value to a card (no transaction is obligatory)

Specified by:

refundStandalone in interface PaymentService

Parameters:

request - instance of StandaloneRefundRequest for a refund details

Returns:

payment transaction entry

refundStandalone

public PaymentTransactionEntryModel refundStandalone(java.lang.String merchantTransactionCode,
                                                     java.math.BigDecimal amount,
                                                     java.util.Currency currency,
                                                     AddressModel paymentAddress,
                                                     CardInfo card)

Description copied from interface: PaymentService

Refund value to a card (no transaction is obligatory)

Specified by:

refundStandalone in interface PaymentService

Parameters:

merchantTransactionCode - any code to locate transaction

amount - amount to refund

currency - currency, used for refunding

paymentAddress - address to refund

card - card to refund

Returns:

payment transaction entry

refundStandalone

public PaymentTransactionEntryModel refundStandalone(java.lang.String merchantTransactionCode,
                                                     java.math.BigDecimal amount,
                                                     java.util.Currency currency,
                                                     AddressModel paymentAddress,
                                                     CardInfo card,
                                                     java.lang.String providerName,
                                                     java.lang.String subscriptionId)

Description copied from interface: PaymentService

Refund value to a card (no transaction is obligatory)

Specified by:

refundStandalone in interface PaymentService

Parameters:

merchantTransactionCode - any code to locate transaction

amount - amount to refund

currency - currency, used for refunding

paymentAddress - address to refund

card - card to refund

providerName - name of the payment provider

subscriptionId - subscription identifier

Returns:

payment transaction entry

partialCapture

public PaymentTransactionEntryModel partialCapture(PaymentTransactionModel transaction,
                                                   java.math.BigDecimal amount)

Description copied from interface: PaymentService

Take a partial capture of authorized transaction

Specified by:

partialCapture in interface PaymentService

Parameters:

transaction - authorized transaction

amount - value to capture

Returns:

payment transaction entry

getPaymentTransaction

public PaymentTransactionModel getPaymentTransaction(java.lang.String code)

Get PaymentTransactionModel by code

Specified by:

getPaymentTransaction in interface PaymentService

Parameters:

code - the code of the PaymentTransactionModel we were looking for

Returns:

the PaymentTransactionModel

Throws:

ModelNotFoundException - if nothing was found

AmbiguousIdentifierException - if by the given searchparams to many models where found

getPaymentTransactionEntry

public PaymentTransactionEntryModel getPaymentTransactionEntry(java.lang.String code)

Get PaymentTransactionEntryModel by code

Specified by:

getPaymentTransactionEntry in interface PaymentService

Parameters:

code - the code of the PaymentTransactionModel we were looking for

Returns:

the PaymentTransactionModel

Throws:

ModelNotFoundException - if nothing was found

AmbiguousIdentifierException - if by the given searchparams to many models where found

attachPaymentInfo

public void attachPaymentInfo(PaymentTransactionModel paymentTransactionModel,
                              UserModel userModel,
                              CardInfo cardInfo,
                              java.math.BigDecimal amount)

Attaches PaymentInfo to the assigned PaymentTransactionModel instance by using the configured PaymentInfoCreatorStrategy.
You can call this method after/before authorization by yourself if there is a need for it.

Specified by:

attachPaymentInfo in interface PaymentService

Parameters:

paymentTransactionModel - the payment transaction

userModel - the user

cardInfo - the card info

amount - the amount

createSubscription

public NewSubscription createSubscription(PaymentTransactionModel transaction,
                                          AddressModel paymentAddress,
                                          CardInfo card)

Description copied from interface: PaymentService

Creates a subscription at the payment provider side and stores sensitive data there. Future payment authorization and refundStandalone calls will not have to provide the sensitive information, subscriptionID would be sufficient. Call this method after a successful authorize txn and provide THE SAME billing and card info. Please note: the card and billing info is not saved in the returning PaymentTransactionEntryModel from authorize method call ON PURPOSE.

Specified by:

createSubscription in interface PaymentService

Parameters:

transaction - a previous recent successful authorize payment transaction

paymentAddress - the same billing address as for the authorize txn

card - the same card as for the authorize txn

Returns:

instance of NewSubscription

createSubscription

public NewSubscription createSubscription(java.lang.String merchantTransactionCode,
                                          java.lang.String paymentProvider,
                                          java.util.Currency currency,
                                          AddressModel paymentAddress,
                                          CardInfo card)

Description copied from interface: PaymentService

Creates a subscription at the payment provider side and stores sensitive data there. Future payment authorization and refundStandalone calls will not have to provide the sensitive information, subscriptionID would be sufficient. This method does not need an authorized payment transaction, the authorization is expected to be done implicitly by the payment provider.

Specified by:

createSubscription in interface PaymentService

Parameters:

merchantTransactionCode - the transactionCode

paymentProvider - the paymentProvider who will hold the subscription. You might also have just one payment provider in your implementation.

currency - the default customer's currency

paymentAddress - the same billing address as for the authorize txn

card - the same card as for the authorize txn

Returns:

new subscription object (instance of NewSubscription)

updateSubscription

public PaymentTransactionEntryModel updateSubscription(java.lang.String merchantTransactionCode,
                                                       java.lang.String subscriptionID,
                                                       java.lang.String paymentProvider,
                                                       AddressModel paymentAddress,
                                                       CardInfo card)

Description copied from interface: PaymentService

Updates the data of the subscription at the payment provider.

Specified by:

updateSubscription in interface PaymentService

Parameters:

merchantTransactionCode - the transactionCode

subscriptionID - the subscription ID

paymentProvider - the paymentProvider who holds the subscription. You get this value from the PaymentTransactionModel of the createSubscription command. You might also have just one payment provider in your implementation.

paymentAddress - the new billing address, could be null

card - the updated card, could be null

Returns:

instance of PaymentTransactionEntryModel

getSubscriptionData

public PaymentTransactionEntryModel getSubscriptionData(java.lang.String merchantTransactionCode,
                                                        java.lang.String subscriptionID,
                                                        java.lang.String paymentProvider,
                                                        BillingInfo billingInfo,
                                                        CardInfo card)

Description copied from interface: PaymentService

Gets the stored card info or payment address

Specified by:

getSubscriptionData in interface PaymentService

Parameters:

merchantTransactionCode - the transactionCode

subscriptionID - the subscription ID

paymentProvider - the paymentProvider who holds the subscription. You get this value from the PaymentTransactionModel of the createSubscription command. You might also have just one payment provider in your implementation.

billingInfo - the billing address is returned in this DTO

card - the card information is returned in this DTO

Returns:

instance of PaymentTransactionEntryModel

deleteSubscription

public PaymentTransactionEntryModel deleteSubscription(java.lang.String merchantTransactionCode,
                                                       java.lang.String subscriptionID,
                                                       java.lang.String paymentProvider)

Description copied from interface: PaymentService

Deletes the subscription at the payment provider. Warning: Deleting a customer profile is permanent. You cannot recover a deleted customer profile.

Specified by:

deleteSubscription in interface PaymentService

Parameters:

merchantTransactionCode - the transactionCode

subscriptionID - the subscription ID

paymentProvider - the paymentProvider who holds the subscription. You get this value from the PaymentTransactionModel of the createSubscription command. You might also have just one payment provider in your implementation.

Returns:

instance of PaymentTransactionEntryModel

getCommonI18NService

protected CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getFlexibleSearchService

protected FlexibleSearchService getFlexibleSearchService()

setFlexibleSearchService

public void setFlexibleSearchService(FlexibleSearchService flexibleSearchService)

getPaymentInfoCreator

protected PaymentInfoCreatorStrategy getPaymentInfoCreator()

setPaymentInfoCreator

public void setPaymentInfoCreator(PaymentInfoCreatorStrategy paymentInfoCreator)

getTransactionCodeGenerator

protected TransactionCodeGenerator getTransactionCodeGenerator()

setTransactionCodeGenerator

public void setTransactionCodeGenerator(TransactionCodeGenerator transactionCodeGenerator)

getCardPaymentService

protected CardPaymentService getCardPaymentService()

setCardPaymentService

public void setCardPaymentService(CardPaymentService cardPaymentService)