Interface IPaymentMethod
Represents a payment method for Payments that are processed by a Payment Gateway.
Namespace: EPiServer.Commerce.Order
Assembly: EPiServer.Business.Commerce.dll
Version: 12.17.2Syntax
public interface IPaymentMethodProperties
Description
Gets the description of the payment method.
Declaration
string Description { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Name
Gets the payment method name.
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
PaymentMethodId
Gets the id of the payment method.
Declaration
Guid PaymentMethodId { get; }Property Value
| Type | Description |
|---|---|
| System.Guid |
SystemKeyword
Gets the system keyword of the payment method.
Declaration
string SystemKeyword { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
CreatePayment(Decimal, IOrderGroup)
Creates and returns an instance of a new IPayment based on the current payment method.
Declaration
IPayment CreatePayment(decimal amount, IOrderGroup orderGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.Decimal | amount | The amount to be paid. |
| IOrderGroup | orderGroup | The IOrderGroup the payment belongs to. |
Returns
| Type | Description |
|---|---|
| IPayment | An IPayment. |
ValidateData()
Validates input related to the payment method, to be used before creating the actual IPayment.
Declaration
bool ValidateData()Returns
| Type | Description |
|---|---|
| System.Boolean | Returns |
