The CMSPaymentGatewayProvider type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
 | CMSPaymentGatewayProvider |
Methods
| Name | Description | |
|---|---|---|
 | AddAdditionalInfoToPaymentResult |
Adds some additional information to payment result, such as time stamp and payment method name.
|
| CreatePaymentResultInfo |
Creates payment result object - base PaymentResultInfo object is created by default.
|
|  Equals | (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetPaymentDataFormPath |
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.
|
 | GetPaymentGatewayProvider |
Returns payment gateway provider instance.
|
| GetPaymentGatewayUrl |
Returns payment gateway url.
|
| GetType | Gets the (Inherited from Type of the current instance.Object.) |
| InitializeGatewayControl |
Adds payment gateway custom data to the current shopping cart step - payment gateway form with initialized custom controls is added by default.
|
| IsUserAuthorizedToFinishPayment |
Checks whether specified user is authorized to finish payment.
|
| MemberwiseClone | Creates a shallow copy of the current (Inherited from Object.Object.) |
| ProcessCustomData |
Process payment gateway custom data of the current shopping cart step - payment gateway form data processing is performed by default.
|
| ProcessPayment |
Process payment - you need to override this method to process payment by your custom payment processor.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateOrderPaymentResult |
Updates order payment result in database.
|
| 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.
|
| ValidateCustomData |
Validates payment gateway custom data of the current shopping cart step - payment gateway form data validation is performed by default.
|
Extension Methods
| Name | Description | |
|---|---|---|
 | GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Fields
| Name | Description | |
|---|---|---|
 | mErrorMessage |
Payment result message displayed to user when payment fails.
|
| mInfoMessage |
Payment result message displayed to user when payment succeeds.
|
| mIsPaymentCompleted |
Indicates whether payment is already completed.
|
| mOrder |
Order object which is going to be paid.
|
| mOrderId |
Order ID.
|
| mPaymentDataContainer |
Payment gateway data container of the current shopping cart step control.
|
| mPaymentDataForm |
Payment gateway form with custom controls.
|
| mPaymentResult |
Payment result.
|
| mShoppingCartControl |
Parent shopping cart control the current shopping cart step belongs to.
|
| mShoppingCartInfoObj |
Shopping cart object which stores all data during the checkout process.
|
Properties
| Name | Description | |
|---|---|---|
 | ErrorMessage |
Payment result message displayed to user when payment fails.
|
| InfoMessage |
Payment result message displayed to user when payment succeeds.
|
| IsPaymentCompleted |
Indicates whether payment is already completed.
|
| Order |
Order object which is going to be paid.
|
| OrderId |
Order ID. Set this value when you want to process payment for the existing order outside the checkout process.
|
 | PaymentDataForm |
Payment gateway form with custom controls.
|
| PaymentResult |
Payment result.
|
| ShoppingCartControl |
Parent shopping cart control the current shopping cart step belongs to.
|
| 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.
|
See Also