Previous Docs Version

The documentation you are viewing is for a previous version of the Vendr product. Click here to jump to the current stable version.

PaymentProviderBase

API reference for PaymentProviderBase in Vendr, the eCommerce solution for Umbraco v8+

PaymentProviderBase

public abstract class PaymentProviderBase : IPaymentProvider

Inheritance

Namespace

Properties

Alias

public string Alias { get; }

CanCancelPayments

public virtual bool CanCancelPayments { get; }

CanCapturePayments

public virtual bool CanCapturePayments { get; }

CanFetchPaymentStatus

public virtual bool CanFetchPaymentStatus { get; }

CanRefundPayments

public virtual bool CanRefundPayments { get; }

DefaultSettings

public virtual IDictionary<string, string> DefaultSettings { get; }

Description

public string Description { get; }

FinalizeAtContinueUrl

public virtual bool FinalizeAtContinueUrl { get; }

Icon

public string Icon { get; }

Name

public string Name { get; }

SettingDefinitions

public virtual IEnumerable<PaymentProviderSettingDefinition> SettingDefinitions { get; }

TransactionMetaDataDefinitions

public virtual IEnumerable<TransactionMetaDataDefinition> TransactionMetaDataDefinitions { get; }

Methods

CancelPayment

public virtual ApiResult CancelPayment(OrderReadOnly order, 
    IReadOnlyDictionary<string, string> settings)

CanProcessOrder

public virtual bool CanProcessOrder(OrderReadOnly order, 
    IReadOnlyDictionary<string, string> settings, ref string errorMessage)

CapturePayment

public virtual ApiResult CapturePayment(OrderReadOnly order, 
    IReadOnlyDictionary<string, string> settings)

FetchPaymentStatus

public virtual ApiResult FetchPaymentStatus(OrderReadOnly order, 
    IReadOnlyDictionary<string, string> settings)

GenerateForm

public abstract PaymentFormResult GenerateForm(OrderReadOnly order, string continueUrl, 
    string cancelUrl, string callbackUrl, IReadOnlyDictionary<string, string> settings)

GetCancelUrl

public abstract string GetCancelUrl(OrderReadOnly order, 
    IReadOnlyDictionary<string, string> settings)

GetContinueUrl

public abstract string GetContinueUrl(OrderReadOnly order, 
    IReadOnlyDictionary<string, string> settings)

GetErrorUrl

public abstract string GetErrorUrl(OrderReadOnly order, 
    IReadOnlyDictionary<string, string> settings)

GetOrderReference

public virtual OrderReference GetOrderReference(HttpRequestBase request, 
    IReadOnlyDictionary<string, string> settings)

ProcessCallback

public abstract CallbackResult ProcessCallback(OrderReadOnly order, HttpRequestBase request, 
    IReadOnlyDictionary<string, string> settings)

RefundPayment

public virtual ApiResult RefundPayment(OrderReadOnly order, 
    IReadOnlyDictionary<string, string> settings)

Edit this page on GitHub

Site + logo design © 2025 Outfield Digital Ltd. Content contributions licensed under MIT.
Vendr® is a Registered Trademark of Outfield Digital Ltd.