How to

Create a Custom External Payment Module for a PSP

Step 1: First study the documentation of the PSP to see what has to be customized in the default external payment module (for example, custom steps).

Step 2: Create a new assembly/project that will contain the custom payment method, while it is possible to add it to any existing assembly, this will make it easier to distribute the payment method.

Step 3: Create a new payment class that will inherit from the 'ExternalPaymentModule' Class, this will be the base class for implementing the custom PSP provider.

protected override bool OnPay(IOrderContext order, NameValueCollection externalConfiguration)

public virtual void Confirm(IOrder order, HttpRequest request, NameValueCollection externalParameters)

public virtual void Finish(IOrder order, HttpRequest request, NameValueCollection externalParameters)

public virtual void Aborted(IOrder order, HttpRequest request, NameValueCollection externalParameters)

public virtual NameValueCollection CreateResponse(IOrder order, NameValueCollection externalParameters)

protected virtual PaymentContext Initialize(IOrderContext order, NameValueCollection externalParameters)

protected virtual void SetPaymentConfiguration(IOrder order, List<PaymentConfigurationSetting> configuration)

public virtual string GetPaymentStatus(IOrderContext context)

protected virtual string ResolvePaymentStatus(string status, string method, IEnumerable<IPaymentStatusLookup> statusLookup)

protected virtual string GetPSPPaymentStatus(IOrderContext context)

protected virtual string GetPSPPaymentMethod(IOrderContext context)

protected virtual string GetPaymentInformation(IOrder order, string key)

protected virtual void BuildPipelines()

protected virtual IPaymentPipeline BuildPreProcessPipeline()

using System;
using System.Collections.Generic;
using Sana.Commerce.Payment.Pipeline;
namespace Sana.Commerce.Payment.DocData
{
    /// <summary>
    /// This step is responsible for initializing Payment Information.
    /// </summary>
    public class InitializePaymentInformationStep : IPaymentStep
    {
        /// <summary>
        /// Initialize Request information in the Order Context.
        /// </summary>
        /// <param name="entity">The strongly typed objects that should be passed to the step.</param>
        /// <param name="properties">A collection of objects that can be extended in any way.</param>
        public void Execute(IOrderContext entity, IDictionary<string, object> properties)
        {
            //Add Payment Request information to the Order
            entity.Order[Order.OrderFields.PaymentInformation] = CreatePaymentRequestValues(entity);
        }
        /// <summary>
        /// Creates the payment request values.
        /// </summary>
        /// <param name="entity">Order context.</param>
        /// <returns>Payment information.</returns>
        protected virtual Order.PaymentInformation CreatePaymentRequestValues(IOrderContext entity)
        {
            var configValues = new Order.PaymentInformation();
            string paymentInfoField = Order.OrderFields.PaymentInformation;
            if (entity.Order.Fields.ContainsKey(paymentInfoField))
                configValues = (Order.PaymentInformation)entity.Order[paymentInfoField];            
            foreach (var config in entity.Payment.Configuration)
            {
                if (config.IsRequestParameter)
                    configValues.Request.Add(new Order.PaymentConfiguration { Name = config.Name, Value = config.Value });
            }            
            return configValues;
        }
    }
}

protected virtual IPaymentPipeline BuildConfirmPipeline()

protected virtual IPaymentPipeline BuildPostProcessPipeline()

protected virtual IPaymentPipeline BuildCancelPipeline()

protected virtual List<IPaymentPipeline> BuildCustomPipelines()

List<IPaymentPipeline> pipeline = new List<IPaymentPipeline>();
 //Pipeline executed if paymentstatus is ok
 var okSteps = new IPaymentStep[ ]
 {     
  //Add steps here
  new PayOrderStep(),     //Set order status to paid
  new DeductStockStep(),  //Deduct the stock from the ordered products
  new SendOrderMailStep(),    //Send an order mail to the user
  new DeleteBasketStep()     //Delete the basket of the user
 };
 pipeline.Add(new PaymentPipeline("StatusOkPipeline", okSteps));
 var cancelSteps = new IPaymentStep[ ]
 {     
  //Add steps here
   new CancelOrderStep()
 };
 pipeline.Add(new PaymentPipeline("StatusCancelPipeline", cancelSteps));
 var pendingSteps = new IPaymentStep[ ]
 {     
   //Add steps here          
   new PendingOrderStep(),
   new SendOrderMailStep()   
 };
 pipeline.Add(new PaymentPipeline("StatusPendingPipeline",
 pendingSteps));
 return pipeline; 

protected virtual NameValueCollection GetXmlReponseParameter(IOrder order)

protected virtual NameValueCollection GetReponseParameters(IOrder order)

protected virtual string GenerateRedirectUrl(IOrder order, bool getParameters)

<add name="CustomValue" value="1" isRequestParameter="false" /> 

Configuration.Where(value => value.Name = "CustomValue").First().Value;