CMSCreditPaymentProvider Class

Class providing methods and properties for credit payment.

Inheritance Hierarchy

System.Object
  CMS.Ecommerce.CMSPaymentGatewayProvider
    CMS.Ecommerce.CMSCreditPaymentProvider

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 13.0.131

Syntax

public class CMSCreditPaymentProvider : CMSPaymentGatewayProvider, 
	IDirectPaymentGatewayProvider, IPaymentGatewayProvider

The CMSCreditPaymentProvider type exposes the following members.

Constructors

	Name	Description
Public method	CMSCreditPaymentProvider()	Initializes a new instance of a CMSCreditPaymentProvider.
Public method	CMSCreditPaymentProvider(ICurrencyConverterService, ISiteMainCurrencySource, IRoundingServiceFactory, ICreditEventInfoProvider, IOrderInfoProvider)	Initializes a new instance of a CMSCreditPaymentProvider.

Fields

	Name	Description
Protected field	mAvailableCreditInMainCurrency	Available credit in main currency.
Protected field	mAvailableCreditInOrderCurrency	Available credit in order currency.
Protected field	mExchangeRate	Exchange rate.
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	mPaymentResult	Payment result. (Inherited from CMSPaymentGatewayProvider.)
Protected field	mShoppingCartInfoObj	Shopping cart object which stores all data during the checkout process. (Inherited from CMSPaymentGatewayProvider.)

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	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	PaymentResult	Payment result. (Inherited from CMSPaymentGatewayProvider.)
Public property	ReloadAction	Gets or sets the action which is then called during ReloadPaymentData() method call.
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
Protected method	AddAdditionalInfoToPaymentResult	Adds some additional information to payment result, such as time stamp and payment method name. (Inherited from CMSPaymentGatewayProvider.)
Protected method	CheckOrder	Check, whether Order and Shopping cart objects are present. In case Order or ShoppingcartInfo object is not set (Inherited from CMSPaymentGatewayProvider.)
Protected method	CreatePaymentResultInfo	Creates payment result object - base PaymentResultInfo object is created by default. (Inherited from CMSPaymentGatewayProvider.)
Protected method	GetPaymentGatewayUrl	Returns payment gateway url. (Inherited from CMSPaymentGatewayProvider.)
Public method	HasCustomerEnoughCredit	Indicates whether customer has enough credit to finish payment.
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	ProcessPayment	Process payment.
Public method	ReloadPaymentData	Reloads payment data - order and main currencies, their exchange rates, customer available credit.
Protected method	RoundPrice	Transform given price into string representation according to given formatProvider and formatString. (Inherited from CMSPaymentGatewayProvider.)
Protected method	UpdateOrderPaymentResult	Updates order payment result in database. (Inherited from CMSPaymentGatewayProvider.)
Public method	UseDelayedPayment	Returns whether both gateway and provider shall use delayed payment method. (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.)