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.

IPaymentProvider

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

IPaymentProvider

public interface IPaymentProvider

Namespace

Properties

Alias

public string Alias { get; }

CanCancelPayments

public bool CanCancelPayments { get; }

CanCapturePayments

public bool CanCapturePayments { get; }

CanFetchPaymentStatus

public bool CanFetchPaymentStatus { get; }

CanRefundPayments

public bool CanRefundPayments { get; }

DefaultSettings

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

Description

public string Description { get; }

FinalizeAtContinueUrl

public bool FinalizeAtContinueUrl { get; }

Icon

public string Icon { get; }

Name

public string Name { get; }

SettingDefinitions

public IEnumerable<PaymentProviderSettingDefinition> SettingDefinitions { get; }

TransactionMetaDataDefinitions

public IEnumerable<TransactionMetaDataDefinition> TransactionMetaDataDefinitions { get; }

Methods

CancelPayment

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

CanProcessOrder

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

CapturePayment

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

FetchPaymentStatus

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

GenerateForm

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

GetCancelUrl

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

GetContinueUrl

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

GetErrorUrl

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

GetOrderReference

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

ProcessCallback

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

RefundPayment

public 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.