Class PaymentTransaction

Namespace

Dynamicweb.Ecommerce.Orders.PaymentTransactions

Assembly

Dynamicweb.Ecommerce.dll

Represents a transaction (payment).

public sealed class PaymentTransaction

Inheritance

object

PaymentTransaction

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

PaymentTransactionExtensions.GetSumOfOperationType(PaymentTransaction, PaymentTransactionEventType)

PaymentTransactionExtensions.IsCaptureAvailableForPayment(PaymentTransaction)

PaymentTransactionExtensions.IsFullyCaptured(PaymentTransaction)

PaymentTransactionExtensions.IsFullyRefunded(PaymentTransaction)

PaymentTransactionExtensions.IsPaymentAuthorized(PaymentTransaction)

PaymentTransactionExtensions.IsPaymentCancelled(PaymentTransaction)

PaymentTransactionExtensions.IsPaymentCaptured(PaymentTransaction)

PaymentTransactionExtensions.IsPaymentRefunded(PaymentTransaction)

PaymentTransactionExtensions.IsRefundAvailableForPayment(PaymentTransaction)

Constructors

PaymentTransaction(PaymentTransactionKey, string)

Initializes a new instance of the PaymentTransaction class.

public PaymentTransaction(PaymentTransactionKey identifier, string currencyCode)

Parameters

identifier PaymentTransactionKey

currencyCode string

Exceptions

ArgumentNullException

If identifier is null.

ArgumentException

If currencyCode is null or empty.

Properties

Acquirer

Gets the acquirer.

public string? Acquirer { get; init; }

Property Value

string

Examples

nets, clearhaus, etc.

AuthorizedAmount

Gets the amount that was authorized.

public double AuthorizedAmount { get; init; }

Property Value

double

CapturedAmount

Gets the amount that was captured.

public double CapturedAmount { get; init; }

Property Value

double

CreatedDate

Gets the date when the transaction was created.

public DateTime CreatedDate { get; init; }

Property Value

DateTime

CurrencyCode

Gets the currency code. The standard used is ISO 3166-1 alpha-3.

public string CurrencyCode { get; }

Property Value

string

Examples

EUR, DKK, etc.

CustomerEmail

The email address of the customer.

public string? CustomerEmail { get; init; }

Property Value

string

Events

Gets the events related to the payment transaction.

public IReadOnlyCollection<PaymentTransactionEvent>? Events { get; init; }

Property Value

IReadOnlyCollection<PaymentTransactionEvent>

Identifier

Gets the payment transaction identifier.

public PaymentTransactionKey Identifier { get; }

Property Value

PaymentTransactionKey

Merchant

Gets the merchant ID.

public string? Merchant { get; init; }

Property Value

string

MetaData

Gets the metadata for the payment transaction.

public PaymentTransactionMetaData? MetaData { get; init; }

Property Value

PaymentTransactionMetaData

OrderId

Gets the order ID.

public string? OrderId { get; init; }

Property Value

string

State

Gets the state of the payment transaction.

public PaymentTransactionState State { get; init; }

Property Value

PaymentTransactionState