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.

IPaymentMethodService

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

IPaymentMethodService

Defines the Vendr Payment Method service

public interface IPaymentMethodService : ICachedEntityService<PaymentMethodReadOnly>, IService

Inheritance

Namespace

Methods

DeletePaymentMethod (1 of 2)

Deletes a PaymentMethod

public void DeletePaymentMethod(Guid id)

Parameters

Parameter Description
id
The ID of the PaymentMethod to delete

DeletePaymentMethod (2 of 2)

Deletes a PaymentMethod

public void DeletePaymentMethod(PaymentMethod entity)

Parameters

Parameter Description
entity
The PaymentMethod to delete

GetPaymentMethod (1 of 2)

Get a PaymentMethodReadOnly entity by ID

public PaymentMethodReadOnly GetPaymentMethod(Guid id)

Parameters

Parameter Description
id
The ID of the PaymentMethodReadOnly entity to fetch

Returns

A PaymentMethodReadOnly entity


GetPaymentMethod (2 of 2)

Get a PaymentMethodReadOnly entity by Store and Alias

public PaymentMethodReadOnly GetPaymentMethod(Guid storeId, string alias)

Parameters

Parameter Description
storeId
The ID of the Store the PaymentMethodReadOnly entity belongs to
alias
The Alias of the PaymentMethodReadOnly entity to fetch

Returns

A PaymentMethodReadOnly entity


GetPaymentMethods

Get a list of all PaymentMethodReadOnly entities from the given Store

public IEnumerable<PaymentMethodReadOnly> GetPaymentMethods(Guid storeId)

Parameters

Parameter Description
storeId
The ID of the Store the PaymentMethodReadOnly entities belong to

Returns

A list of PaymentMethodReadOnly entities


GetPaymentMethodsAllowedIn

Get a list of all PaymentMethodReadOnly entities allowed in the given Country and Region

public IEnumerable<PaymentMethodReadOnly> GetPaymentMethodsAllowedIn(Guid countryId, 
    Guid? regionId = default(Guid?))

Parameters

Parameter Description
countryId
The ID of the Country the PaymentMethodReadOnly entities should be allowed in
regionId
The ID of the Region the PaymentMethodReadOnly entities should be allowed in

Returns

A list of PaymentMethodReadOnly entities


PaymentMethodExists

Check to see if a PaymentMethodReadOnly exists in the given Store with the given Alias

public bool PaymentMethodExists(Guid storeId, string alias)

Parameters

Parameter Description
storeId
The ID of the Store the PaymentMethodReadOnly entity belongs to
alias
The Alias of the PaymentMethodReadOnly entity to check

Returns

Returns true if the PaymentMethodReadOnly exists, otherwise returns false.


SavePaymentMethod

Saves a PaymentMethod

public void SavePaymentMethod(PaymentMethod entity)

Parameters

Parameter Description
entity
The PaymentMethod to save

SortPaymentMethods

Sorts a list of PaymentMethod entities by ID according to the order of those IDs

public void SortPaymentMethods(Guid[] sortedIds)

Parameters

Parameter Description
sortedIds
The IDs of the PaymentMethod entities to sort, in the order by which to sort them

Edit this page on GitHub

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