Click or drag to resize
CMSPaymentGatewayProvider Class
Class providing base methods and properties for payment gateway management.
Inheritance Hierarchy

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

The CMSPaymentGatewayProvider type exposes the following members.

Constructors
  NameDescription
Protected methodCMSPaymentGatewayProvider
Top
Fields
  NameDescription
Protected fieldmErrorMessage
Payment result message displayed to user when payment fails.
Protected fieldmInfoMessage
Payment result message displayed to user when payment succeeds.
Protected fieldmIsPaymentCompleted
Indicates whether payment is already completed.
Protected fieldmOrder
Order object which is going to be paid.
Protected fieldmOrderId
Order ID.
Protected fieldmPaymentDataContainer
Payment gateway data container of the current shopping cart step control.
Protected fieldmPaymentDataForm
Payment gateway form with custom controls.
Protected fieldmPaymentResult
Payment result.
Protected fieldmShoppingCartControl
Parent shopping cart control the current shopping cart step belongs to.
Protected fieldmShoppingCartInfoObj
Shopping cart object which stores all data during the checkout process.
Top
Properties
  NameDescription
Public propertyErrorMessage
Payment result message displayed to user when payment fails.
Public propertyInfoMessage
Payment result message displayed to user when payment succeeds.
Public propertyIsPaymentCompleted
Indicates whether payment is already completed.
Public propertyOrder
Order object which is going to be paid.
Public propertyOrderId
Order ID. Set this value when you want to process payment for the existing order outside the checkout process.
Protected propertyPaymentDataForm
Payment gateway form with custom controls.
Public propertyPaymentResult
Payment result.
Public propertyShoppingCartControl
Parent shopping cart control the current shopping cart step belongs to.
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.
Top
Methods
  NameDescription
Public methodAddAdditionalInfoToPaymentResult
Adds some additional information to payment result, such as time stamp and payment method name.
Public methodCreatePaymentResultInfo
Creates payment result object - base PaymentResultInfo object is created by default.
Public methodGetPaymentDataFormPath
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 methodStatic memberGetPaymentGatewayProvider
Returns payment gateway provider instance.
Public methodGetPaymentGatewayUrl
Returns payment gateway url.
Public methodInitializeGatewayControl
Adds payment gateway custom data to the current shopping cart step - payment gateway form with initialized custom controls is added by default.
Public methodIsUserAuthorizedToFinishPayment
Checks whether specified user is authorized to finish payment.
Public methodProcessCustomData
Process payment gateway custom data of the current shopping cart step - payment gateway form data processing is performed by default.
Public methodProcessPayment
Process payment - you need to override this method to process payment by your custom payment processor.
Public methodUpdateOrderPaymentResult
Updates order payment result in database.
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.
Public methodValidateCustomData
Validates payment gateway custom data of the current shopping cart step - payment gateway form data validation is performed by default.
Top
See Also