How to

Create a Custom Payment Pipeline Step

Step 1: Create a new class that inherits from 'IPaymentStep' and implement the 'Execute' method. This class will be our new payment step.

public void Execute(IOrderContext entity, IDictionary<string, object>
      properties)
{
}

Step 2: In the execute method add custom code that implements the step. The step can be used in any payment pipeline now!

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Sana.Utilities.Validation;
/// <summary>
    /// This steps sets the order status of an order to closed.
    /// </summary>
    public class PayOrderStep : IPaymentStep
    {
        /// <summary>
        /// Set the order status of an order to closed.
        /// </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)
        {
            //For now we only set the order status to closed...
            Guard.ThrowIfNull(entity, "entity", "PaymentContext cannot be null.");
            Guard.ThrowIfNull(entity.Order, "entity.Order", "Order in the PaymentContext cannot be null for the PayOrderStep.");
           
            entity.Order.PaymentStatus = PaymentStatus.Paid;
            //Note Order will be saved by the pipeline so we will not have to do it here.
            PaymentLog.Current.Add(entity.Order, string.Format("PayOrderStep - the status of the order {0} was set to closed.", entity.Order.OrderId), false);
        }
    }