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<TSettingsModel>

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

PaymentProviderBase<TSettingsModel>

public abstract class PaymentProviderBase<TSettingsModel> : PaymentProviderBase
    where TSettingsModel : new()

Inheritance

Namespace

Constructors

PaymentProviderBase<TSettingsModel>

public PaymentProviderBase(VendrContext vendr)

Properties

SettingDefinitions

public override IEnumerable<PaymentProviderSettingDefinition> SettingDefinitions { get; }

Methods

CancelPayment

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

CancelPayment

public virtual ApiResult CancelPayment(OrderReadOnly order, TSettingsModel settings)

CanProcessOrder

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

CanProcessOrder

public virtual bool CanProcessOrder(OrderReadOnly order, TSettingsModel settings, 
    ref string errorMessage)

CapturePayment

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

CapturePayment

public virtual ApiResult CapturePayment(OrderReadOnly order, TSettingsModel settings)

FetchPaymentStatus

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

FetchPaymentStatus

public virtual ApiResult FetchPaymentStatus(OrderReadOnly order, TSettingsModel settings)

GenerateForm

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

GenerateForm

public abstract PaymentFormResult GenerateForm(OrderReadOnly order, string continueUrl, 
    string cancelUrl, string callbackUrl, TSettingsModel settings)

GetCancelUrl

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

GetCancelUrl

public abstract string GetCancelUrl(OrderReadOnly order, TSettingsModel settings)

GetContinueUrl

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

GetContinueUrl

public abstract string GetContinueUrl(OrderReadOnly order, TSettingsModel settings)

GetErrorUrl

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

GetErrorUrl

public abstract string GetErrorUrl(OrderReadOnly order, TSettingsModel settings)

GetOrderReference

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

GetOrderReference

public virtual OrderReference GetOrderReference(HttpRequestBase request, TSettingsModel settings)

ProcessCallback

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

ProcessCallback

public abstract CallbackResult ProcessCallback(OrderReadOnly order, HttpRequestBase request, 
    TSettingsModel settings)

RefundPayment

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

RefundPayment

public virtual ApiResult RefundPayment(OrderReadOnly order, TSettingsModel 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.