IPaymentMethodService
Defines the Vendr Payment Method service
public interface IPaymentMethodService : ICachedEntityService<PaymentMethodReadOnly>, IServiceInheritance
- interface ICachedEntityService<TEntityType>
- interface IService
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 (1 of 2)
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
GetPaymentMethods (2 of 2)
Get a list of PaymentMethodReadOnly entities with the given IDs
public IEnumerable<PaymentMethodReadOnly> GetPaymentMethods(Guid[] ids)Parameters
| Parameter | Description |
|---|---|
ids |
The IDs of the PaymentMethodReadOnly entities to fetch |
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 |