CMSCreditPaymentProvider Class

Class providing methods and properties for credit payment.

Inheritance Hierarchy

System.Object
  CMS.EcommerceProvider.CMSPaymentGatewayProvider
    CMS.EcommerceProvider.CMSCreditPaymentProvider

Namespace: CMS.EcommerceProvider
Assembly: CMS.EcommerceProvider (in CMS.EcommerceProvider.dll) Version: 9.0.0

Syntax

public class CMSCreditPaymentProvider : CMSPaymentGatewayProvider

The CMSCreditPaymentProvider type exposes the following members.

Constructors

	Name	Description
Public method	CMSCreditPaymentProvider

Fields

	Name	Description
Public field Static member	CREDIT_PAYMENT_FORM_ID	ID of the credit payment form control.
Protected field	mAvailableCreditInMainCurrency	Available credit in main currency.
Protected field	mAvailableCreditInOrderCurrency	Available credit in order currency.
Protected field	mErrorMessage	Payment result message displayed to user when payment fails. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mExchangeRate	Exchange rate.
Protected field	mInfoMessage	Payment result message displayed to user when payment succeeds. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mIsPaymentCompleted	Indicates whether payment is already completed. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mMainCurrencyObj	Main currency data object.
Protected field	mOrder	Order object which is going to be paid. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mOrderCurrencyObj	Order currency data object.
Protected field	mOrderId	Order ID. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mPaymentDataContainer	Payment gateway data container of the current shopping cart step control. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mPaymentDataForm	Payment gateway form with custom controls. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mPaymentResult	Payment result. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mShoppingCartControl	Parent shopping cart control the current shopping cart step belongs to. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mShoppingCartInfoObj	Shopping cart object which stores all data during the checkout process. (Inherited from CMSPaymentGatewayProvider.)
Protected field Static member	VALUE_NOT_KNOWN	This constant says that value of the credit is not known.

Properties

	Name	Description
Public property	AvailableCreditInMainCurrency	Available credit in main currency.
Public property	AvailableCreditInOrderCurrency	Available credit in order currency.
Public property	CreditChangeAfterPayment	Credit change after payment.
Public property	ErrorMessage	Payment result message displayed to user when payment fails. (Inherited from CMSPaymentGatewayProvider.)
Public property	ExchangeRate	Exchange rate between main and order currencies.
Public property	HasCustomerEnoughCredit	Indicates whether customer has enough credit to finish payment.
Public property	InfoMessage	Payment result message displayed to user when payment succeeds. (Inherited from CMSPaymentGatewayProvider.)
Public property	IsPaymentCompleted	Indicates whether payment is already completed. (Inherited from CMSPaymentGatewayProvider.)
Public property	MainCurrencyObj	Main currency info object.
Public property	Order	Order object which is going to be paid. (Inherited from CMSPaymentGatewayProvider.)
Public property	OrderCurrencyObj	Order currency info object.
Public property	OrderId	Order ID. Set this value when you want to process payment for the existing order outside the checkout process. (Inherited from CMSPaymentGatewayProvider.)
Protected property	PaymentDataForm	Payment gateway form with custom controls. (Inherited from CMSPaymentGatewayProvider.)
Public property	PaymentResult	Payment result. (Inherited from CMSPaymentGatewayProvider.)
Public property	ShoppingCartControl	Parent shopping cart control the current shopping cart step belongs to. (Inherited from CMSPaymentGatewayProvider.)
Public property	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. (Inherited from CMSPaymentGatewayProvider.)

Methods

	Name	Description
Public method	AddAdditionalInfoToPaymentResult	Adds some additional information to payment result, such as time stamp and payment method name. (Inherited from CMSPaymentGatewayProvider.)
Public method	CreatePaymentResultInfo	Creates payment result object - base PaymentResultInfo object is created by default. (Inherited from CMSPaymentGatewayProvider.)
Public method	GetPaymentDataFormPath	Returns payment gateway form path with custom controls. (Overrides CMSPaymentGatewayProvider.GetPaymentDataFormPath().)
Public method	GetPaymentGatewayUrl	Returns payment gateway url. (Inherited from CMSPaymentGatewayProvider.)
Public method	InitializeGatewayControl	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 method	IsUserAuthorizedToFinishPayment(Boolean)	Checks whether current user is authorized to finish payment, if he is not authorized sets corresponding payment gateway error message.
Public method	IsUserAuthorizedToFinishPayment(UserInfo, ShoppingCartInfo, Boolean)	Checks whether specified user is authorized to finish payment, if he is not authorized sets corresponding payment gateway error message. (Overrides CMSPaymentGatewayProvider.IsUserAuthorizedToFinishPayment(UserInfo, ShoppingCartInfo, Boolean).)
Public method	ProcessCustomData	Process payment gateway custom data of the current shopping cart step - payment gateway form data processing is performed by default. (Inherited from CMSPaymentGatewayProvider.)
Public method	ProcessPayment	Process payment. (Overrides CMSPaymentGatewayProvider.ProcessPayment().)
Public method	ReloadPaymentData	Reloads payment data - order and main currencies, their exchange rates, customer available credit.
Public method	UpdateOrderPaymentResult	Updates order payment result in database. (Inherited from CMSPaymentGatewayProvider.)
Protected method	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. (Inherited from CMSPaymentGatewayProvider.)
Public method	ValidateCustomData	Validates payment gateway custom data of the current shopping cart step - payment gateway form data validation is performed by default. (Inherited from CMSPaymentGatewayProvider.)