Class Payment

Base class for Payments, every payment accepted by the order system should be inherited from this class.

Implements
System.Xml.Serialization.IXmlSerializable
System.ICloneable
System.Runtime.Serialization.ISerializable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Mediachase.Commerce.Orders
Assembly: Mediachase.Commerce.dll
Version: 10.8.0
Syntax
public abstract class Payment : OrderStorageBase, IXmlSerializable, IStorageObject, ICloneable, ISerializable, IPayment, IExtendedProperties

Constructors

Payment(MetaClass)

Initializes a new instance of the Payment class.

Declaration
public Payment(MetaClass metaClass)
Parameters
Type Name Description
MetaClass metaClass

The meta class.

Payment(MetaClass, Func<String, Object>)

Declaration
protected Payment(MetaClass metaClass, Func<string, object> getFieldValue)
Parameters
Type Name Description
MetaClass metaClass
System.Func<System.String, System.Object> getFieldValue

Payment(SerializationInfo, StreamingContext)

Initializes a new instance of the Payment class.

Declaration
protected Payment(SerializationInfo info, StreamingContext context)
Parameters
Type Name Description
System.Runtime.Serialization.SerializationInfo info

The info.

System.Runtime.Serialization.StreamingContext context

The context.

Fields

PaymentTypeField

Declaration
protected const string PaymentTypeField = "PaymentType"
Field Value
Type Description
System.String

Properties

Amount

Gets or sets the amount.

Declaration
public decimal Amount { get; set; }
Property Value
Type Description
System.Decimal

The amount.

AuthorizationCode

Gets or sets the authorization code.

Declaration
public string AuthorizationCode { get; set; }
Property Value
Type Description
System.String

The authorization code.

BillingAddressId

Gets or sets the billing address id.

Declaration
public string BillingAddressId { get; set; }
Property Value
Type Description
System.String

The billing address id.

CustomerName

Gets or sets the name of the customer.

Declaration
public string CustomerName { get; set; }
Property Value
Type Description
System.String

The name of the customer.

ImplementationClass

Gets or sets the implementation class.

Declaration
public string ImplementationClass { get; set; }
Property Value
Type Description
System.String

The implementation class.

OrderFormId

Gets or sets the order form id.

Declaration
public int OrderFormId { get; set; }
Property Value
Type Description
System.Int32

The order form id.

OrderGroupId

Gets or sets the order group id.

Declaration
public int OrderGroupId { get; set; }
Property Value
Type Description
System.Int32

The order group id.

Parent

Gets the parent OrderForm payment belongs to.

Declaration
public OrderForm Parent { get; }
Property Value
Type Description
OrderForm

The parent.

PaymentId

Gets the payment id.

Declaration
public int PaymentId { get; }
Property Value
Type Description
System.Int32

The payment id.

PaymentMethodId

Gets or sets the payment method id.

Declaration
public Guid PaymentMethodId { get; set; }
Property Value
Type Description
System.Guid

The payment method id.

PaymentMethodName

Gets or sets the name of the payment method.

Declaration
public string PaymentMethodName { get; set; }
Property Value
Type Description
System.String

The name of the payment method.

PaymentType

Gets or sets the type of the payment. Types are CreditCard, CashCard, Invoice, GiftCard, Other

Declaration
public PaymentType PaymentType { get; set; }
Property Value
Type Description
PaymentType

The type of the payment.

ProviderTransactionID

Gets or sets the transaction ID which is returned from Payment Provider.

Declaration
public string ProviderTransactionID { get; set; }
Property Value
Type Description
System.String

The transaction ID.

Status

Gets or sets the status.

Declaration
public string Status { get; set; }
Property Value
Type Description
System.String

The status.

TransactionID

Gets or sets the transaction ID.

Declaration
public string TransactionID { get; set; }
Property Value
Type Description
System.String

The transaction ID.

TransactionType

Gets or sets the type of the transaction.

Declaration
public string TransactionType { get; set; }
Property Value
Type Description
System.String

The type of the transaction. Mapped to TransactionType enumeration.

ValidationCode

Gets or sets the validation code.

Declaration
public string ValidationCode { get; set; }
Property Value
Type Description
System.String

The validation code.

Methods

AcceptChanges()

Accepts the changes.

Declaration
public override void AcceptChanges()
Overrides

GetObjectData(SerializationInfo, StreamingContext)

Gets the object data.

Declaration
public override void GetObjectData(SerializationInfo info, StreamingContext context)
Parameters
Type Name Description
System.Runtime.Serialization.SerializationInfo info

The info.

System.Runtime.Serialization.StreamingContext context

The context.

Overrides

SetParent(Object)

Sets the parent.

Declaration
public override void SetParent(object parent)
Parameters
Type Name Description
System.Object parent

The parent.

Overrides

WriteXml(XmlWriter)

Converts an object into its XML representation.

Declaration
public override void WriteXml(XmlWriter writer)
Parameters
Type Name Description
System.Xml.XmlWriter writer

The System.Xml.XmlWriter stream to which the object is serialized

Overrides

Explicit Interface Implementations

IPayment.BillingAddress

Declaration
IOrderAddress IPayment.BillingAddress { get; set; }
Returns
Type Description
IOrderAddress

IExtendedProperties.Properties

Gets the property bag for dealing with custom meta fields.

Declaration
Hashtable IExtendedProperties.Properties { get; }
Returns
Type Description
System.Collections.Hashtable

Implements

System.Xml.Serialization.IXmlSerializable
System.ICloneable
System.Runtime.Serialization.ISerializable