PaymentResultInfo Class

Class representing payment result.

Inheritance Hierarchy

System.Object
  CMS.Ecommerce.PaymentResultInfo
    CMS.Ecommerce.AuthorizeNetPaymentResultInfo
    CMS.Ecommerce.PayPalPaymentResultInfo

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

Syntax

[SerializableAttribute]
public class PaymentResultInfo : ISerializable

The PaymentResultInfo type exposes the following members.

Constructors

	Name	Description
Public method	PaymentResultInfo()	Creates base PaymentResultInfo object - following fields are created in payment result XML definition, they are not initialized: date, payment method, payment is completed, payment status, transaction id, description.
Public method	PaymentResultInfo(String)	Creates PaymentResultInfo object.
Public method	PaymentResultInfo(SerializationInfo, StreamingContext)	Constructor - Creates a new PaymentResultInfo object from serialized data.

Methods

	Name	Description
Public method	EnsurePaymentResultItemInfo	Tries to find specified payment result item (if it is not found it is created and initialized with item name and item header) and returns it.
Public method	GetFormattedPaymentResultString	Returns formatted payment result string which is visible to the user.
Public method	GetObjectData	Gets object data.
Public method	GetPaymentResultItemInfo	Returns payment result item object.
Public method	GetPaymentResultXml	Returns payment result XML string.
Public method	LoadPaymentResultXml	Loads payment result xml.
Public method	SetPaymentResultItemInfo	Updates/Inserts payment result item data in/into payment result.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	PaymentDate	Payment date.
Public property	PaymentDescription	Payment result description.
Public property	PaymentIsCompleted	TRUE - payment was completed successfully, FALSE - payment wasn't already completed.
Public property	PaymentMethodID	Payment method ID.
Public property	PaymentMethodName	Payment method name.
Public property	PaymentStatusName	Payment status display name.
Public property	PaymentStatusValue	Payment status value.
Public property	PaymentTransactionID	Payment result transaction ID.