CMSPaymentGatewayProvider Class

Class providing base methods and properties for payment gateway management.

Inheritance Hierarchy

System.Object
  CMS.Ecommerce.CMSPaymentGatewayProvider
    CMS.Ecommerce.CMSAuthorizeNetProvider
    CMS.Ecommerce.CMSCreditPaymentProvider
    CMS.Ecommerce.CMSPayPalProvider

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 12.0.0

Syntax

public abstract class CMSPaymentGatewayProvider : IPaymentGatewayProvider

The CMSPaymentGatewayProvider type exposes the following members.

Constructors

	Name	Description
Protected method	CMSPaymentGatewayProvider

Fields

	Name	Description
Protected field	mIsPaymentCompleted	Indicates whether payment is already completed.
Protected field	mOrder	Order object which is going to be paid.
Protected field	mOrderId	Order ID.
Protected field	mPaymentResult	Payment result.
Protected field	mShoppingCartInfoObj	Shopping cart object which stores all data during the checkout process.

Properties

	Name	Description
Public property	ErrorMessage	Payment result message displayed to user when payment fails.
Public property	InfoMessage	Payment result message displayed to user when payment succeeds.
Public property	IsPaymentCompleted	Indicates whether payment is already completed.
Public property	Order	Order object which is going to be paid.
Public property	OrderId	Order ID. Set this value when you want to process payment for the existing order outside the checkout process.
Protected property	PaymentResult	Payment result.
Public property	ShoppingCartInfoObj	Shopping cart object which stores all data during the checkout process. If OrderId is set it is created from existing order, otherwise it is returned from current shopping cart control.

Methods

	Name	Description
Protected method	AddAdditionalInfoToPaymentResult	Adds some additional information to payment result, such as time stamp and payment method name.
Protected method	CheckOrder	Check, whether Order and Shopping cart objects are present. In case Order or ShoppingcartInfo object is not set
Protected method	CreatePaymentResultInfo	Creates payment result object - base PaymentResultInfo object is created by default.
Public method Static member	GetPaymentGatewayProvider<TProvider>	Returns payment gateway provider instance of given generic type.
Protected method	GetPaymentGatewayUrl	Returns payment gateway url.
Public method	IsUserAuthorizedToFinishPayment	Checks whether specified user is authorized to finish payment.
Protected method Static member	LogEvent	Logs error with given message, eventCode and eventSource to event log.
Protected method	RoundPrice	Transform given price into string representation according to given formatProvider and formatString.
Protected method	UpdateOrderPaymentResult	Updates order payment result in database.
Public method	UseDelayedPayment	Returns whether both gateway and provider shall use delayed payment method.
Public method	ValidateCustomData	Validates payment gateway custom data of the current shopping cart step - payment gateway form data validation is performed by default.