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: 12.0.0

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.

Properties

	Name	Description
Public property	PaymentApprovalUrl	Gets or sets the url with allowing to approve payment.
Public property	PaymentAuthorizationID	Gets or sets the payment authorization ID.
Public property	PaymentDate	Payment date.
Public property	PaymentDescription	Payment result description.
Public property	PaymentIsAuthorized	Indicates whether the payment is already authorized and capture is possible.
Public property	PaymentIsCompleted	Indicates whether the payment is successfully completed.
Public property	PaymentIsFailed	Indicates whether the payment failed.
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.

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.