Creating a payment processor plugin

Payment plugins provide store customers with option to pay through a particular payment processor. The following document explains the process to create a new payment processor plugin.

Creating the plugin class

A payment plugin is any class that implements EvenCart.Services.Plugins.IPaymentHandlerPlugin interface. The interface has following properties and methods that the plugin class requires to implement.

TransactionRequest Object

A transaction request object contains information about the transaction to be done with the use of payment processor. The following properties can be used to get the relevant information.

TransactionResult Object

The ProcessTransaction method must return a TransactionResult object which stores information about the transaction result. A result object has the following properties and method.

Plugin Class Example

A sample payment class after implementation looks as follows.

using System;
using System.Collections.Generic;
using System.Linq;
using EvenCart.Core.Plugins;
using EvenCart.Data.Entity.Payments;
using EvenCart.Data.Entity.Purchases;
using EvenCart.Services.Payments;
using EvenCart.Services.Plugins;
using EvenCart.Infrastructure;

namespace Payments.MyPaymentPlugin
{
    public class MyPaymentPlugin : FoundationPlugin, IPaymentHandlerPlugin
    {
        private readonly MyPaymentSettings _paymentSettings;
        public MyPaymentPlugin(MyPaymentSettings paymentSettings)
        {
            _paymentSettings = paymentSettings;
        }

        public PaymentMethodType PaymentMethodType => PaymentMethodType.CreditCard;

        public string PaymentHandlerComponentRouteName => "MyPaymentComponent";

        public PaymentOperation[] SupportedOperations => new[]
            {PaymentOperation.Authorize, PaymentOperation.Capture, PaymentOperation.Refund, PaymentOperation.Void};

        public TransactionResult ProcessTransaction(TransactionRequest request)
        {
            var order = request.Order;
            /* do some processing here */
            var transactionResult = new TransactionResult(){
                Success = true,

            }
            return transactionResult;
        }

        public decimal GetPaymentHandlerFee(Cart cart)
        {
            //if required, you can inspect CartItems property of cart to 
            //add any additional fee based on their products
            return 0;
        }

        public decimal GetPaymentHandlerFee(Order order)
        {
            //if required, you can inspect OrderItems property of cart to 
            //add any additional fee based on their products
            return 0;
        }

        public bool ValidatePaymentInfo(Dictionary<string, string> parameters, out string error)
        {
            error = null;
            var cardNumber = parameters["CardNumber"];
            ...
            //validate card number and other info.
            return true;
        }

        public override string ConfigurationUrl => ApplicationEngine.RouteUrl("MyPaymentConfiguration");

    }
}