Click or drag to resize
CMSCreditPaymentProvider Class
Class providing methods and properties for credit payment.
Inheritance Hierarchy
SystemObject
  CMS.EcommerceCMSPaymentGatewayProvider
    CMS.EcommerceCMSCreditPaymentProvider

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

The CMSCreditPaymentProvider type exposes the following members.

Constructors
Fields
  NameDescription
Protected fieldmAvailableCreditInMainCurrency
Available credit in main currency.
Protected fieldmAvailableCreditInOrderCurrency
Available credit in order currency.
Protected fieldmExchangeRate
Exchange rate.
Protected fieldmIsPaymentCompleted
Indicates whether payment is already completed.
(Inherited from CMSPaymentGatewayProvider.)
Protected fieldmMainCurrencyObj
Main currency data object.
Protected fieldmOrder
Order object which is going to be paid.
(Inherited from CMSPaymentGatewayProvider.)
Protected fieldmOrderCurrencyObj
Order currency data object.
Protected fieldmOrderId
Order ID.
(Inherited from CMSPaymentGatewayProvider.)
Protected fieldmPaymentResult
Payment result.
(Inherited from CMSPaymentGatewayProvider.)
Protected fieldmShoppingCartInfoObj
Shopping cart object which stores all data during the checkout process.
(Inherited from CMSPaymentGatewayProvider.)
Top
Properties
  NameDescription
Public propertyAvailableCreditInMainCurrency
Available credit in main currency.
Public propertyAvailableCreditInOrderCurrency
Available credit in order currency.
Public propertyCreditChangeAfterPayment
Credit change after payment.
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 propertyMainCurrencyObj
Main currency info object.
Public propertyOrder
Order object which is going to be paid.
(Inherited from CMSPaymentGatewayProvider.)
Public propertyOrderCurrencyObj
Order currency info object.
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 propertyPaymentResult
Payment result.
(Inherited from CMSPaymentGatewayProvider.)
Public propertyReloadAction
Gets or sets the action which is then called during ReloadPaymentData method call.
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
Protected methodAddAdditionalInfoToPaymentResult
Adds some additional information to payment result, such as time stamp and payment method name.
(Inherited from CMSPaymentGatewayProvider.)
Protected methodCheckOrder
Check, whether Order and Shopping cart objects are present. In case Order or ShoppingcartInfo object is not set
(Inherited from CMSPaymentGatewayProvider.)
Protected methodCreatePaymentResultInfo
Creates payment result object - base PaymentResultInfo object is created by default.
(Inherited from CMSPaymentGatewayProvider.)
Protected methodGetPaymentGatewayUrl
Returns payment gateway url.
(Inherited from CMSPaymentGatewayProvider.)
Public methodHasCustomerEnoughCredit
Indicates whether customer has enough credit to finish payment.
Public methodIsUserAuthorizedToFinishPayment(Boolean)
Checks whether current user is authorized to finish payment, if he is not authorized sets corresponding payment gateway error message.
Public methodIsUserAuthorizedToFinishPayment(UserInfo, ShoppingCartInfo, Boolean)
Checks whether specified user is authorized to finish payment, if he is not authorized sets corresponding payment gateway error message.
(Overrides CMSPaymentGatewayProviderIsUserAuthorizedToFinishPayment(UserInfo, ShoppingCartInfo, Boolean).)
Public methodProcessPayment
Process payment.
Public methodReloadPaymentData
Reloads payment data - order and main currencies, their exchange rates, customer available credit.
Protected methodRoundPrice
Transform given price into string representation according to given formatProvider and formatString.
(Inherited from CMSPaymentGatewayProvider.)
Protected methodUpdateOrderPaymentResult
Updates order payment result in database.
(Inherited from CMSPaymentGatewayProvider.)
Public methodUseDelayedPayment
Returns whether both gateway and provider shall use delayed payment method.
(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