CMSPaymentGatewayProvider Class

Class providing base methods and properties for payment gateway management.

Inheritance Hierarchy

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

Namespace: CMS.Ecommerce.Web.UI
Assembly: CMS.Ecommerce.Web.UI (in CMS.Ecommerce.Web.UI.dll) Version: 10.0.0

Syntax

public abstract class CMSPaymentGatewayProvider

The CMSPaymentGatewayProvider type exposes the following members.

Constructors

	Name	Description
Protected method	CMSPaymentGatewayProvider

Fields

	Name	Description
Protected field	mErrorMessage	Payment result message displayed to user when payment fails.
Protected field	mInfoMessage	Payment result message displayed to user when payment succeeds.
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	mPaymentDataContainer	Payment gateway data container of the current shopping cart step control.
Protected field	mPaymentDataForm	Payment gateway form with custom controls.
Protected field	mPaymentResult	Payment result.
Protected field	mShoppingCartControl	Parent shopping cart control the current shopping cart step belongs to.
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	PaymentDataForm	Payment gateway form with custom controls.
Public property	PaymentResult	Payment result.
Public property	ShoppingCartControl	Parent shopping cart control the current shopping cart step belongs to.
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
Public method	AddAdditionalInfoToPaymentResult	Adds some additional information to payment result, such as time stamp and payment method name.
Public method	CreatePaymentResultInfo	Creates payment result object - base PaymentResultInfo object is created by default.
Public method	GetPaymentDataFormPath	Returns CMSPaymentGatewayForm form virtual path with custom controls which are used to display/input customer payment data, such as credit card number etc.- you need to override this method to load your custom controls.
Public method Static member	GetPaymentGatewayProvider	Returns payment gateway provider instance.
Public method	GetPaymentGatewayUrl	Returns payment gateway url.
Public method	InitializeGatewayControl	Adds payment gateway custom data to the current shopping cart step - payment gateway form with initialized custom controls is added by default.
Public method	IsUserAuthorizedToFinishPayment	Checks whether specified user is authorized to finish payment.
Public method	ProcessCustomData	Process payment gateway custom data of the current shopping cart step - payment gateway form data processing is performed by default.
Public method	ProcessPayment	Process payment - you need to override this method to process payment by your custom payment processor.
Public method	UpdateOrderPaymentResult	Updates order payment result in database.
Protected method	UpdateOrderStatus	Assigns order status to order. If can not be used due to global objects settings, looks for site status with the same code name.
Public method	ValidateCustomData	Validates payment gateway custom data of the current shopping cart step - payment gateway form data validation is performed by default.