CMSPayPalProvider Class

Class providing payment using PayPal payment gateway.

Inheritance Hierarchy

System.Object
  CMS.Ecommerce.CMSPaymentGatewayProvider
    CMS.Ecommerce.CMSPayPalProvider

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

Syntax

public class CMSPayPalProvider : CMSPaymentGatewayProvider, 
	IDirectPaymentGatewayProvider, IPaymentGatewayProvider, IDelayedPaymentGatewayProvider

The CMSPayPalProvider type exposes the following members.

Constructors

	Name	Description
Public method	CMSPayPalProvider

Fields

	Name	Description
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	mPaymentResult	Payment result. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mShoppingCartInfoObj	Shopping cart object which stores all data during the checkout process. (Inherited from CMSPaymentGatewayProvider.)

Properties

	Name	Description
Protected property	Culture	Gets PayPal gateway compatible culture.
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	IsPaymentAuthorized	Indicates whether the payment is already authorized meaning that payment capture is possible.
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	PaymentResult	Payment result. (Inherited from CMSPaymentGatewayProvider.)
Protected property	PayPalPaymentResult	Gets strongly typed 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. (Inherited from CMSPaymentGatewayProvider.)

Methods

	Name	Description
Protected method	AddAdditionalInfoToPaymentResult	Adds some additional information to payment result, such as time stamp and payment method name. (Inherited from CMSPaymentGatewayProvider.)
Protected method	AddOrderDiscountItem	Adds item with negative value of OrderDiscount into given items collection.
Protected method	AddOtherPaymentItem	Adds item with negative value of OtherPayments into given items collection.
Public method	AuthorizePayment	Authorizes a payment.
Protected method	AuthorizePaymentInternal	Authorizes a payment.
Protected method	CallGatewayWithExceptionHandling	Provides shared exception handling for any method connecting to gateway.
Public method	CapturePayment	Captures a payment.
Protected method	CapturePaymentInternal	Captures a payment.
Protected method	CheckOrder	Check, whether Order and Shopping cart objects are present. In case Order or ShoppingcartInfo object is not set (Inherited from CMSPaymentGatewayProvider.)
Protected method	CreatePaymentResultInfo	Creates PayPal payment result object. (Overrides CMSPaymentGatewayProvider.CreatePaymentResultInfo().)
Public method	ExecutePayment	Executes payment for given paymentId and payerId. Both values has to be obtained from payment gateway. Payment cannot be captured unless its authorization is confirmed.
Protected method	ExecutePaymentInternal	Executes payment for given paymentId and payerId.
Protected method	GetApprovalUrl	Returns url for approving the authorization from given payment.
Protected method	GetBillingAddress	Returns billing address created from order used for payment authorization.
Protected method	GetCancelUrl	Returns cancellation url for payment request
Protected method	GetCapture	Returns Capture created from Order used for payment capture.
Protected method	GetDetailUrl	Returns url with payment detail from given payment.
Protected method	GetItem	Returns item created from given parameters.
Protected method	GetItemPrice	Returns unit price of one item required by the gateway.
Protected method	GetPayerInfo	Returns information about payer created from order used for payment authorization.
Protected method	GetPayment	Returns Payment created from Order used for payment authorization.
Protected method	GetPaymentGatewayUrl	Returns payment gateway url. (Inherited from CMSPaymentGatewayProvider.)
Protected method	GetPaymentItems	Returns collection of Item created from order items used for payment authorization.
Protected method	GetPaymentStatusName	Returns payment status name for given paypal response state.
Protected method	GetProductItems	Returns item created from given cartItem.
Protected method	GetReturnUrl	Returns return url for payment request
Protected method	GetShippingAddress	Returns shipping address created from order used for payment authorization.
Protected method	GetTransactionAmount	Returns Amount object providing money amount information required by gateway.
Protected method	GetTransactionAmountShipping	Returns shipping value required by the gateway.
Protected method	GetTransactionAmountSubtotal	Returns subtotal value required by the gateway.
Protected method	IsDelayedPayment	Returns true when given payment has authorize intent.
Protected method Static member	IsDirectPayment	Returns true when given payment has sale intent.
Public method	IsUserAuthorizedToFinishPayment	Checks whether specified user is authorized to finish payment. (Inherited from CMSPaymentGatewayProvider.)
Protected method	ProcessExecutedDelayedPayment	Sets authorization related data from given payment to PayPalPaymentResult.
Protected method	ProcessExecutedDirectPayment	Sets payment related data from given payment to PayPalPaymentResult.
Public method	ProcessPayment	Processes the payment on external gateway.
Protected method	ProcessPaymentInternal	Process the direct payment.
Protected method	RoundPrice	Transform given price into string representation according to given formatProvider and formatString. (Inherited from CMSPaymentGatewayProvider.)
Protected method	RunPaymentExecution	Runs payment execution for paymentId and payerId.
Protected method	UpdateOrderPaymentResult	Updates order payment result in database. (Inherited from CMSPaymentGatewayProvider.)
Public method	UseDelayedPayment	Returns whether both gateway and provider shall use delayed payment method. (Overrides CMSPaymentGatewayProvider.UseDelayedPayment().)
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.)
Protected method	ValidatePayment	Validates given payment before the gateway request is performed.