Class ConsolidatedPaymentCreationParameters

Namespace

Dynamicweb.Ecommerce.Orders

Assembly

Dynamicweb.Ecommerce.dll

Represents the parameters required to create a consolidated payment for multiple orders.

public sealed class ConsolidatedPaymentCreationParameters

Inheritance

object

ConsolidatedPaymentCreationParameters

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Use this class to specify the payment order identifier, the collection of associated paid order identifiers, and optional order state updates for fully or partially paid orders when creating a consolidated payment. The order state updates are applied when the checkout process completes the payment order.

Properties

PaidOrderIds

A collection of identifiers for the paid orders associated with the payment order.

public IReadOnlyCollection<string> PaidOrderIds { get; init; }

Property Value

IReadOnlyCollection<string>

PaidOrderStateId

The order state ID to set for fully paid orders. If not specified, the order state will not be updated for fully paid orders. The order state is updated when the checkout process completes the payment order.

public string? PaidOrderStateId { get; init; }

Property Value

string

PartiallyPaidOrderStateId

The order state ID to set for partially paid orders. If not specified, the order state will not be updated for partially paid orders. The order state is updated when the checkout process completes the payment order.

public string? PartiallyPaidOrderStateId { get; init; }

Property Value

string

PaymentOrderId

The identifier of the payment order.

public required string PaymentOrderId { get; init; }

Property Value

string