Class Payment

Namespace

Dynamicweb.Ecommerce.Orders

Assembly

Dynamicweb.Ecommerce.dll

Represents information about a payment method

[Serializable]
public class Payment

Inheritance

object

Payment

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Payment()

Initializes a new instance of the Payment class.

public Payment()

Properties

Active

Gets or sets the value indicating whether instance is active.

public bool Active { get; set; }

Property Value

bool

AllowAnonymousUsers

Gets or sets a value indicating whether the Payment is available to anonymous users.

public bool AllowAnonymousUsers { get; set; }

Property Value

bool

true if payment is available to anonymous users; otherwise, false.

CaptureObject

Gets the capture object.

public IRemoteCapture CaptureObject { get; }

Property Value

IRemoteCapture

The capture object.

CheckoutParameters

Gets or sets the checkout parameters.

public string CheckoutParameters { get; set; }

Property Value

string

The checkout parameters.

CheckoutSystemName

Gets or sets the system name of the checkout addIn .

public string CheckoutSystemName { get; set; }

Property Value

string

The system name of the checkout addIn.

Code

Gets or sets the code.

public string Code { get; set; }

Property Value

string

GatewayId

Gets or sets the gateway ID.

public string GatewayId { get; set; }

Property Value

string

The gateway ID.

GatewayParameters

Gets or sets the gateway parameters.

public string GatewayParameters { get; set; }

Property Value

string

The gateway parameters.

Icon

Gets or sets the icon file name.

public string Icon { get; set; }

Property Value

string

The icon.

IconOrderList

Gets or sets the icon file name for order list.

public string IconOrderList { get; set; }

Property Value

string

The icon order list.

Id

Gets or sets the ID.

public string Id { get; set; }

Property Value

string

The ID.

PaymentAddInType

Gets or sets the type of the addIn.

public PaymentAddInTypes PaymentAddInType { get; set; }

Property Value

PaymentAddInTypes

The type of the addIn.

Sorting

Sort order of current group inside parent group's children collection

public int Sorting { get; set; }

Property Value

int

TermsCode

Gets or sets the payment terms code.

public string TermsCode { get; set; }

Property Value

string

Translations

Gets the translations

public TranslationCollection<PaymentTranslation> Translations { get; }

Property Value

TranslationCollection<PaymentTranslation>

UserGroups

Gets or sets to whom user groups the payment is shown.

public IEnumerable<int> UserGroups { get; set; }

Property Value

IEnumerable<int>

Methods

Clone()

Clones this instance.

public Payment Clone()

Returns

Payment

GetDescription(string)

Gets the description of the payment for the given language.

public string GetDescription(string languageId)

Parameters

languageId string

Returns

string

GetName(string)

Gets the name of the payment for the given language.

public string GetName(string languageId)

Parameters

languageId string

Returns

string

GetTermsDescription(string)

Gets the terms description of the payment for the given language.

public string GetTermsDescription(string languageId)

Parameters

languageId string

Returns

string

SetDescription(string, string)

Sets the description of the payment for the given language.

public void SetDescription(string languageId, string description)

Parameters

languageId string

description string

SetName(string, string)

Sets the name of the payment for the given language.

public void SetName(string languageId, string name)

Parameters

languageId string

name string

SetTermsDescription(string, string)

Sets the terms description of the payment for the given language.

public void SetTermsDescription(string languageId, string termsDescription)

Parameters

languageId string

termsDescription string