Class PaymentTransactionService

Namespace

Dynamicweb.Ecommerce.Orders.PaymentTransactions

Assembly

Dynamicweb.Ecommerce.dll

public class PaymentTransactionService

Inheritance

object

PaymentTransactionService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

CancelPayment(PaymentTransactionKey)

Attempts to cancel the payment transaction.

public virtual PaymentTransactionCancelResult CancelPayment(PaymentTransactionKey key)

Parameters

key PaymentTransactionKey

The key of the payment transaction

Returns

PaymentTransactionCancelResult

An instance of PaymentTransactionCancelResult representing the result of the cancellation.

GetByIds(IEnumerable<string>, string)

Gets payment transactions by the provided IDs and payment ID.

public virtual IEnumerable<PaymentTransaction> GetByIds(IEnumerable<string> ids, string paymentId)

Parameters

ids IEnumerable<string>

paymentId string

Returns

IEnumerable<PaymentTransaction>

Exceptions

ArgumentNullException

An exception is thrown if the ids is null.

GetByKey(PaymentTransactionKey)

Gets payment transaction by the provided PaymentTransactionKey, or null if not found

public virtual PaymentTransaction? GetByKey(PaymentTransactionKey key)

Parameters

key PaymentTransactionKey

The key of the payment transaction

Returns

PaymentTransaction

GetPaymentTransactionProviderInfo(string)

Gets PaymentTransactionProviderInfo for the provided payment ID.

public virtual PaymentTransactionProviderInfo? GetPaymentTransactionProviderInfo(string paymentId)

Parameters

paymentId string

Returns

PaymentTransactionProviderInfo?

GetPaymentTransactionProviderInfos()

Gets PaymentTransactionProviderInfos about all available IPaymentTransactionProvider implementations.

public virtual IEnumerable<PaymentTransactionProviderInfo> GetPaymentTransactionProviderInfos()

Returns

IEnumerable<PaymentTransactionProviderInfo>

GetPaymentTransactionsBySearch(PaymentTransactionSearchFilter, string)

Gets payment transactions by search settings

public virtual PaymentTransactionSearchResult GetPaymentTransactionsBySearch(PaymentTransactionSearchFilter searchFilter, string paymentId)

Parameters

searchFilter PaymentTransactionSearchFilter

paymentId string

Returns

PaymentTransactionSearchResult

Exceptions

ArgumentNullException

An exception is thrown if the searchFilter is null.