Click or drag to resize
CMSPayPalProvider Class
Class providing payment using PayPal payment gateway.
Inheritance Hierarchy

Namespace: CMS.EcommerceProvider
Assembly: CMS.EcommerceProvider (in CMS.EcommerceProvider.dll) Version: 9.0.0
Syntax
C#
public class CMSPayPalProvider : CMSPaymentGatewayProvider

The CMSPayPalProvider type exposes the following members.

Constructors
  NameDescription
Public methodCMSPayPalProvider
Top
Fields
  NameDescription
Protected fieldmErrorMessage
Payment result message displayed to user when payment fails.
(Inherited from CMSPaymentGatewayProvider.)
Protected fieldmInfoMessage
Payment result message displayed to user when payment succeeds.
(Inherited from CMSPaymentGatewayProvider.)
Protected fieldmIsPaymentCompleted
Indicates whether payment is already completed.
(Inherited from CMSPaymentGatewayProvider.)
Protected fieldmOrder
Order object which is going to be paid.
(Inherited from CMSPaymentGatewayProvider.)
Protected fieldmOrderId
Order ID.
(Inherited from CMSPaymentGatewayProvider.)
Protected fieldmPaymentDataContainer
Payment gateway data container of the current shopping cart step control.
(Inherited from CMSPaymentGatewayProvider.)
Protected fieldmPaymentDataForm
Payment gateway form with custom controls.
(Inherited from CMSPaymentGatewayProvider.)
Protected fieldmPaymentResult
Payment result.
(Inherited from CMSPaymentGatewayProvider.)
Protected fieldmShoppingCartControl
Parent shopping cart control the current shopping cart step belongs to.
(Inherited from CMSPaymentGatewayProvider.)
Protected fieldmShoppingCartInfoObj
Shopping cart object which stores all data during the checkout process.
(Inherited from CMSPaymentGatewayProvider.)
Top
Properties
  NameDescription
Public propertyErrorMessage
Payment result message displayed to user when payment fails.
(Inherited from CMSPaymentGatewayProvider.)
Public propertyInfoMessage
Payment result message displayed to user when payment succeeds.
(Inherited from CMSPaymentGatewayProvider.)
Public propertyIsPaymentCompleted
Indicates whether payment is already completed.
(Inherited from CMSPaymentGatewayProvider.)
Public propertyOrder
Order object which is going to be paid.
(Inherited from CMSPaymentGatewayProvider.)
Public propertyOrderId
Order ID. Set this value when you want to process payment for the existing order outside the checkout process.
(Inherited from CMSPaymentGatewayProvider.)
Protected propertyPaymentDataForm
Payment gateway form with custom controls.
(Inherited from CMSPaymentGatewayProvider.)
Public propertyPaymentResult
Payment result.
(Inherited from CMSPaymentGatewayProvider.)
Public propertyShoppingCartControl
Parent shopping cart control the current shopping cart step belongs to.
(Inherited from CMSPaymentGatewayProvider.)
Public propertyShoppingCartInfoObj
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.)
Top
Methods
  NameDescription
Public methodAddAdditionalInfoToPaymentResult
Adds some additional information to payment result, such as time stamp and payment method name.
(Inherited from CMSPaymentGatewayProvider.)
Public methodComparePaymentDataToOrderData
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 methodConfirmPayment
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 methodCreatePaymentResultInfo
Creates PayPal payment result object.
(Overrides CMSPaymentGatewayProviderCreatePaymentResultInfo.)
Public methodGetOrderDescription
Builds an order description from the order data which is attached to the payment request.
Public methodGetPaymentDataFormPath
Adds payment gateway custom data to the specified shopping cart step.
(Overrides CMSPaymentGatewayProviderGetPaymentDataFormPath.)
Public methodGetPaymentGatewayUrl
Returns payment gateway url.
(Inherited from CMSPaymentGatewayProvider.)
Public methodInitializeGatewayControl
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 methodInitializePaymentRequest
Fills input name-value collection with payment request parameters' names and their values. Values are not URL-encoded.
Public methodIsUserAuthorizedToFinishPayment
Checks whether specified user is authorized to finish payment.
(Inherited from CMSPaymentGatewayProvider.)
Public methodProcessCustomData
Process payment gateway custom data of the current shopping cart step - payment gateway form data processing is performed by default.
(Inherited from CMSPaymentGatewayProvider.)
Public methodProcessPayment
Process payment - initialize payment request and redirect to the PayPal payment gateway to finish payment.
(Overrides CMSPaymentGatewayProviderProcessPayment.)
Public methodUpdateOrderPaymentResult
Updates order payment result in database.
(Inherited from CMSPaymentGatewayProvider.)
Protected methodUpdateOrderStatus
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 methodValidateCustomData
Validates payment gateway custom data of the current shopping cart step - payment gateway form data validation is performed by default.
(Inherited from CMSPaymentGatewayProvider.)
Top
See Also