Click or drag to resize
CMSPaymentGatewayProvider Class
Class providing base methods and properties for payment gateway management.
Inheritance Hierarchy
SystemObject
  CMS.EcommerceCMSPaymentGatewayProvider
    CMS.EcommerceCMSAuthorizeNetProvider
    CMS.EcommerceCMSCreditPaymentProvider
    CMS.EcommerceCMSPayPalProvider

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 13.0.131
Syntax
C#
public abstract class CMSPaymentGatewayProvider : IPaymentGatewayProvider

The CMSPaymentGatewayProvider type exposes the following members.

Constructors
  NameDescription
Protected methodCMSPaymentGatewayProvider
Top
Fields
  NameDescription
Protected fieldmIsPaymentCompleted
Indicates whether payment is already completed.
Protected fieldmOrder
Order object which is going to be paid.
Protected fieldmOrderId
Order ID.
Protected fieldmPaymentResult
Payment result.
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 propertyPaymentResult
Payment result.
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
Protected methodAddAdditionalInfoToPaymentResult
Adds some additional information to payment result, such as time stamp and payment method name.
Protected methodCheckOrder
Check, whether Order and Shopping cart objects are present. In case Order or ShoppingcartInfo object is not set
Protected methodCreatePaymentResultInfo
Creates payment result object - base PaymentResultInfo object is created by default.
Public methodStatic memberGetPaymentGatewayProviderTProvider
Returns payment gateway provider instance of given generic type.
Protected methodGetPaymentGatewayUrl
Returns payment gateway url.
Public methodIsUserAuthorizedToFinishPayment
Checks whether specified user is authorized to finish payment.
Protected methodStatic memberLogEvent
Logs error with given message, eventCode and eventSource to event log.
Protected methodRoundPrice
Transform given price into string representation according to given formatProvider and formatString.
Protected methodUpdateOrderPaymentResult
Updates order payment result in database.
Public methodUseDelayedPayment
Returns whether both gateway and provider shall use delayed payment method.
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