de.hybris.platform.cscockpit.services.payment

Interface CsCardPaymentService

All Known Implementing Classes:

DefaultCsCardPaymentService, DefaultSubscriptionCsCardPaymentService

public interface CsCardPaymentService

Service to support card payments.

Method Summary

Modifier and Type	Method and Description
PaymentTransactionEntryModel	authoriseCardPayment(AbstractOrderModel order, CardInfo cardInfo, double amount) Authorise payment for the cart or order.
List<CreditCardPaymentInfoModel>	getPreviousCreditCardPaymentInfos(UserModel user) Get previously used payment infos for the specified user.
List<CreditCardType>	getSupportedCardSchemes(AbstractOrderModel order) Get the list of available card types for the specified cart or order.
void	validate(AbstractOrderModel order, CardInfo cardInfo, double amount) Validate the order, cardInfo and amount.

Method Detail

getSupportedCardSchemes

List<CreditCardType> getSupportedCardSchemes(AbstractOrderModel order)

Get the list of available card types for the specified cart or order.

Parameters:

order - the cart or order

Returns:

the list of credit card types that are supported

getPreviousCreditCardPaymentInfos

List<CreditCardPaymentInfoModel> getPreviousCreditCardPaymentInfos(UserModel user)

Get previously used payment infos for the specified user. These will be used to pre-populate the card payment form.

Parameters:

user - the user

Returns:

previous payment infos

authoriseCardPayment

PaymentTransactionEntryModel authoriseCardPayment(AbstractOrderModel order,
                                                  CardInfo cardInfo,
                                                  double amount)
                                           throws PaymentException,
                                                  ValidationException

Authorise payment for the cart or order.

Parameters:

order - the cart or order

cardInfo - the payment card data

amount - the amount to authorise

Returns:

the authorisation payment transaction entry

Throws:

PaymentException - thrown on error from the payment service

ValidationException - thrown if the card details are invalid

validate

void validate(AbstractOrderModel order,
              CardInfo cardInfo,
              double amount)
       throws ValidationException

Validate the order, cardInfo and amount. Throw a ValidationException if a payment cannot be processed.

Parameters:

order - the order

cardInfo - the cardInfo

amount - the amount

Throws:

ValidationException - thrown on error.