Class ConsolidatedPayment

Namespace

Dynamicweb.Ecommerce.Orders

Assembly

Dynamicweb.Ecommerce.dll

Represents a payment or a partial payment by one order of another order.

public sealed class ConsolidatedPayment

Inheritance

object

ConsolidatedPayment

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A consolidated payment associates a paid order with a corresponding payment order and may include information about the payment state and amount. This type is immutable.

Properties

CurrencyCode

Gets the currency code of the paid amount. This value is only applicable for partial payments.

public string? CurrencyCode { get; init; }

Property Value

string

Remarks

This value is only applicable for partial payments.

Id

The ID that represents the unique identifier of the consolidated payment record.

public long Id { get; }

Property Value

long

IsPartialPayment

Gets a value indicating whether this payment is a partial payment.

public bool IsPartialPayment { get; init; }

Property Value

bool

PaidAmount

Gets the amount of the paid order that has been paid by the payment order. If not a partial payment, this value is null.

public decimal? PaidAmount { get; init; }

Property Value

decimal?

Remarks

This value is only applicable for partial payments.

PaidOrderId

The order id of the order being paid for.

public required string PaidOrderId { get; init; }

Property Value

string

PaidOrderStateId

The order state id that is set on the paid order when the payment is completed.

public string? PaidOrderStateId { get; init; }

Property Value

string

PaymentOrderId

The id of the order used for payment.

public required string PaymentOrderId { get; init; }

Property Value

string