CMSPayPalProvider Class

Class providing payment using PayPal payment gateway.

Inheritance Hierarchy

System.Object
  CMS.EcommerceProvider.CMSPaymentGatewayProvider
    CMS.EcommerceProvider.CMSPayPalProvider

Namespace: CMS.EcommerceProvider
Assembly: CMS.EcommerceProvider (in CMS.EcommerceProvider.dll) Version: 9.0.0

Syntax

public class CMSPayPalProvider : CMSPaymentGatewayProvider

The CMSPayPalProvider type exposes the following members.

Constructors

	Name	Description
Public method	CMSPayPalProvider

Fields

	Name	Description
Protected field	mErrorMessage	Payment result message displayed to user when payment fails. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mInfoMessage	Payment result message displayed to user when payment succeeds. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mIsPaymentCompleted	Indicates whether payment is already completed. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mOrder	Order object which is going to be paid. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mOrderId	Order ID. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mPaymentDataContainer	Payment gateway data container of the current shopping cart step control. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mPaymentDataForm	Payment gateway form with custom controls. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mPaymentResult	Payment result. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mShoppingCartControl	Parent shopping cart control the current shopping cart step belongs to. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mShoppingCartInfoObj	Shopping cart object which stores all data during the checkout process. (Inherited from CMSPaymentGatewayProvider.)

Properties

	Name	Description
Public property	ErrorMessage	Payment result message displayed to user when payment fails. (Inherited from CMSPaymentGatewayProvider.)
Public property	InfoMessage	Payment result message displayed to user when payment succeeds. (Inherited from CMSPaymentGatewayProvider.)
Public property	IsPaymentCompleted	Indicates whether payment is already completed. (Inherited from CMSPaymentGatewayProvider.)
Public property	Order	Order object which is going to be paid. (Inherited from CMSPaymentGatewayProvider.)
Public property	OrderId	Order ID. Set this value when you want to process payment for the existing order outside the checkout process. (Inherited from CMSPaymentGatewayProvider.)
Protected property	PaymentDataForm	Payment gateway form with custom controls. (Inherited from CMSPaymentGatewayProvider.)
Public property	PaymentResult	Payment result. (Inherited from CMSPaymentGatewayProvider.)
Public property	ShoppingCartControl	Parent shopping cart control the current shopping cart step belongs to. (Inherited from CMSPaymentGatewayProvider.)
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. (Inherited from CMSPaymentGatewayProvider.)

Methods

	Name	Description
Public method	AddAdditionalInfoToPaymentResult	Adds some additional information to payment result, such as time stamp and payment method name. (Inherited from CMSPaymentGatewayProvider.)
Public method	ComparePaymentDataToOrderData	Compares payment data (seller email, total price, payment currency) to order data and returns appropriate error message if data don't match, otherwise returns empty string.
Public method	ConfirmPayment	Confirms payment - post the data that was posted to the merchant back to PayPal and returns PayPal response as result of payment confirmation. Returns "VERIFIED" - payment data match, "INVALID" - payment data don't match.
Public method	CreatePaymentResultInfo	Creates PayPal payment result object. (Overrides CMSPaymentGatewayProvider.CreatePaymentResultInfo().)
Public method	GetOrderDescription	Builds an order description from the order data which is attached to the payment request.
Public method	GetPaymentDataFormPath	Adds payment gateway custom data to the specified shopping cart step. (Overrides CMSPaymentGatewayProvider.GetPaymentDataFormPath().)
Public method	GetPaymentGatewayUrl	Returns payment gateway url. (Inherited from CMSPaymentGatewayProvider.)
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. (Inherited from CMSPaymentGatewayProvider.)
Public method	InitializePaymentRequest	Fills input name-value collection with payment request parameters' names and their values. Values are not URL-encoded.
Public method	IsUserAuthorizedToFinishPayment	Checks whether specified user is authorized to finish payment. (Inherited from CMSPaymentGatewayProvider.)
Public method	ProcessCustomData	Process payment gateway custom data of the current shopping cart step - payment gateway form data processing is performed by default. (Inherited from CMSPaymentGatewayProvider.)
Public method	ProcessPayment	Process payment - initialize payment request and redirect to the PayPal payment gateway to finish payment. (Overrides CMSPaymentGatewayProvider.ProcessPayment().)
Public method	UpdateOrderPaymentResult	Updates order payment result in database. (Inherited from CMSPaymentGatewayProvider.)
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. (Inherited from CMSPaymentGatewayProvider.)
Public method	ValidateCustomData	Validates payment gateway custom data of the current shopping cart step - payment gateway form data validation is performed by default. (Inherited from CMSPaymentGatewayProvider.)