PaymentGatewayManager

The class manages the commerce payment gateway in the CMS.

Namespace

Ektron.Cms.Framework.Commerce.PaymentGatewayManager

Constructors

  • PaymentGatewayManager()
  • PaymentGatewayManager(ApiAccessMode)

Properties

  • ApiMode. Gets or sets the current API access mode. If set to Admin, the API runs with the permissions of an administrator.
  • ApplicationPath. Gets the application path to the Workarea.
  • ContentLanguage. Gets or sets the current content language.
  • InPreviewMode. Gets or sets the preview mode and returns true if the site is in preview mode.
  • IsCommerceEnabled. Checks for a commerce license.
  • RequestInformation. Gets information about the current request.
  • SitePath. Gets the site path.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.Commerce.PaymentGatewayData)

Adds a payment gateway to the CMS. The PaymentGateway.Id property is populated with the payment gateway's ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Name
  • User ID
  • Password
  • Is Default
  • Allow Check Payments

Parameters

  • gatewayData. PaymentGatewayData object to add.

Returns

PaymentGatewayData object.

.aspx code snippet

<ol class="formFields">   
     <li class="clearfix">
        <ektronUI:Label ID="uxPaymentGatewayNameLabel" AssociatedControlID="uxPaymentGatewayName" CssClass="span-3 last" runat="server" Text="* Name:" />
        <ektronUI:TextField  ID="uxPaymentGatewayName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPaymentGatewayUserIdLabel" AssociatedControlID="uxPaymentGatewayUserId" CssClass="span-3 last" runat="server" Text=" User Id:" />
        <ektronUI:TextField  ID="uxPaymentGatewayUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
     <li class="clearfix">
        <ektronUI:Label ID="uxPaymentGatewayPasswordLabel" AssociatedControlID="uxPaymentGatewayPassword" CssClass="span-3 last" runat="server" Text=" Password:" />
        <ektronUI:TextField  ID="uxPaymentGatewayPassword" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>        
    <li class="clearfix">
        <ektronUI:Label ID="uxPaymentGatewayDefaultLabel" AssociatedControlID="uxPaymentGatewayDefault" CssClass="span-3 last" runat="server" Text=" IsDefault:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxPaymentGatewayDefault" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>   
    <li class="clearfix">
        <ektronUI:Label ID="uxPaymentGatewayAllowCheckLabel" AssociatedControlID="uxPaymentGatewayAllowCheckPayments" CssClass="span-3 last" runat="server" Text=" AllowCheckPayments:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxPaymentGatewayAllowCheckPayments" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
     <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            PaymentGatewayManager paymentGatewayManager = new PaymentGatewayManager();
            bool isDefault = false;
            bool allowCheckPayment = false;
            if (uxPaymentGatewayDefault.Checked)
            {
                isDefault = true;
            }
            if (uxPaymentGatewayAllowCheckPayments.Checked)
            {
                allowCheckPayment = true;
            }
            PaymentGatewayData paymentGatewayData = new PaymentGatewayData()
            {
                Name = uxPaymentGatewayName.Text,
                UserId = uxPaymentGatewayUserId.Text,
                Password = uxPaymentGatewayPassword.Text,
                IsDefault = isDefault,
                AllowsCheckPayments = allowCheckPayment
            };

            paymentGatewayData=paymentGatewayManager.Add(paymentGatewayData);
            if (paymentGatewayData.Id > 0)
            {
                MessageUtilities.UpdateMessage(uxMessage, "PaymentGateway Added with Id " + paymentGatewayData.Id, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "PaymentGateway adding process is failed", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

Delete

Delete(System.Int64)

Delete the existing payment gateway.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID

Parameters

  • gatewayId. ID of the gateway to delete.

.aspx code snippet

<ol class="formFields">
   <li class="clearfix">
        <ektronUI:Label ID="uxPaymentGatewayIdLabel" AssociatedControlID="uxPaymentGatewayId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField  ID="uxPaymentGatewayId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>    
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            PaymentGatewayManager paymentGatewayManager = new PaymentGatewayManager();
            long paymentGatewayId = int.Parse(uxPaymentGatewayId.Text);

            paymentGatewayManager.Delete(paymentGatewayId);
            MessageUtilities.UpdateMessage(uxMessage, "PaymentGateway " + paymentGatewayId + " is deleted", Message.DisplayModes.Success );

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

GetDefault

GetDefault()

Returns default payment gateway.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Returns

Default PaymentGatewayData object.

.aspx code snippet

<ol class="formFields">    
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetDefault"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxPassword" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsDefault" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxAllowCreditCards" runat="server"></asp:Literal>
    </li>
</ol>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Framework.User;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            PaymentGatewayManager paymentGatewayManager = new PaymentGatewayManager();
            PaymentGatewayData paymentGatewayData = paymentGatewayManager.GetDefault();

            if (paymentGatewayData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for default payment gateway with ID " + paymentGatewayData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxUserId.Text = "User Id : " + paymentGatewayData.UserId;
                uxPassword.Text = "Password : " + paymentGatewayData.Password;
                uxName.Text = "Name : " + paymentGatewayData.Name;
                uxIsDefault.Text = "IsDefault : " + paymentGatewayData.IsDefault;
                uxAllowCreditCards.Text = "AllowCreditCardPayments : " + paymentGatewayData.AllowsCheckPayments;
            }            
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

GetItem

GetItem(System.Int64)

Retrieves the payment gateway by gateway ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID

Parameters

  • gatewayId. ID of the gateway to retrieved.

Returns

PaymentGatewayData object.

.aspx code snippet

<ol class="formFields">
     <li class="clearfix">
        <ektronUI:Label ID="uxPaymentGatewayIDLabel" AssociatedControlID="uxPaymentGatewayId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxPaymentGatewayId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxPassword" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsDefault" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxAllowCreditCards" runat="server"></asp:Literal>
    </li>
</ol>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Framework.User;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            PaymentGatewayManager paymentGatewayManager = new PaymentGatewayManager();
            long paymentGatewayId=long.Parse(uxPaymentGatewayId.Text);
            PaymentGatewayData paymentGatewayData = paymentGatewayManager.GetItem(paymentGatewayId);

            if (paymentGatewayData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for PaymentGateway with ID " + paymentGatewayData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxUserId.Text = "User Id : " + paymentGatewayData.UserId;
                uxPassword.Text = "Password : " + paymentGatewayData.Password;
                uxName.Text = "Name : " + paymentGatewayData.Name;
                uxIsDefault.Text = "IsDefault : " + paymentGatewayData.IsDefault;
                uxAllowCreditCards.Text = "AllowCreditCardPayments : " + paymentGatewayData.AllowsCheckPayments;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "PaymentGateway " + paymentGatewayId + " does not exist. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

GetList

GetList(Ektron.Cms.Commerce.PaymentGatewayCriteria)

Retrieves a list of payment gateways.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • Payment Gateway Property
  • * Object Value

Parameters

  • criteria. Criteria by which to filter payment gateway being retrieved.

Returns

List of payment gateways meeting criteria filters.

Criteria use

The DataProperty enum works with its criteria class and defines the properties that the Manager class uses to filter and order. Specify zero (0) or more criteria to retrieve the objects you want. The criteria object also lets you set the number of items to return, define paging data, and modify sorting.

Criteria objects
  • Condition. The Logical operator to apply to the filters. The default value is "AND". The criteria condition controls the operator for the default filter group and the AND-ing\Or-ing the filter groups together.
    public Ektron.Cms.Common.LogicalOperation Condition { set; get; }
  • FilterGroups. Gets a list of filter groups. Filter groups can be created to do filter grouping (that is, parentheses in the where clause). The groups use the criteria's condition like other filters, but can use their own condition internally.
    public 
  System.Collections.Generic.List<CriteriaFilterGroup<ActivityCommentProperty>> 
  FilterGroups { get; }
  • Filters. Lists of filters defined in this criteria object. To add new Filters, you can add them here or use the AddFilter method (recommended).
    public 
  System.Collections.Generic.List<CriteriaFilter<ActivityCommentProperty>> 
  Filters { get; }
  • GroupByField. The group by field to apply to the results.
    public 
  Ektron.Cms.Activity.ActivityCommentProperty 
  GroupByField { set; get; }
  • OrderByDirection. Sets the order direction (ascending or descending).
    public EkEnumeration.OrderByDirection 
  OrderByDirection { set; get; }
  • OrderByField . Set the property used to order the results.
    public Ektron.Cms.Activity.ActivityCommentProperty 
  OrderByField { set; get; }
  • PagingInfo. By default, page size is 50 for improved performance. Example paging Info: 
    PagingInfo pageinfo = new PagingInfo();
pageinfo.CurrentPage=1;
pageinfo.RecordsPerPage = 100;
criteria.PagingInfo = pageinfo;
Constructor(property, orderbyDirection)

Sorts the results by a property in ascending or descending order.

AddFilter(property, operator, value)

Filters the results based on the conditions defined in this method.

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo, Objectvalue);
LogicalOperation Condition

Filters the array of items based on the logical condition set in the AddFilter properties. 

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo,Objectvalue);
List<CriteriaFilterGroup> FilterGroups

Binds data to a listview or gridview.

.aspx code snippet

<ol class="formFields">
   <li class="clearfix">
        <ektronUI:Label ID="uxPaymentGatewayPropertyLabel" AssociatedControlID="uxPaymentGatewayProperty" CssClass="span-4 last" runat="server" Text="PaymentGateway Property:" />
        <asp:DropDownList ID="uxPaymentGatewayProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>Name</asp:ListItem>
            <asp:ListItem>IsDefault </asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 last" runat="server" Text="* ObjectValue:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
 
<asp:ListView ID="uxPaymentGatewayListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                       Name
                    </th>
                    <th>
                       User Id
                    </th>
                    <th>
                        IsDefault
                    </th>
                    <th>
                        AllowsCreditCardPayments
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Name")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("IsDefault")%>
            </td>
            <td class="devsite-method">
                <%# Eval("AllowsCreditCardPayments")%>
            </td>
        </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            object Objectvalue;
            PaymentGatewayCriteria criteria = new PaymentGatewayCriteria();

            if (uxPaymentGatewayProperty.SelectedItem.Text == "Id")
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                criteria.AddFilter(PaymentGatewayProperty.Id, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxPaymentGatewayProperty.SelectedItem.Text == "Name")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(PaymentGatewayProperty.Name, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = bool.Parse(uxObjectValue.Text);
                criteria.AddFilter(PaymentGatewayProperty.IsDefault, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            PaymentGatewayManager paymentGatewayManger = new PaymentGatewayManager();
            List<PaymentGatewayData> paymentGatewayList = paymentGatewayManger.GetList(criteria);

            uxPaymentGatewayListView.Visible = true;
            uxPaymentGatewayListView.DataSource = paymentGatewayList;
            uxPaymentGatewayListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

SetDefault

SetDefault(System.Int64)

Mark the existing gateway as default gateway.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Gateway ID

Parameters

  • gatewayId. ID of the gateway to become default.

.aspx code snippet

<ol class="formFields">
   <li class="clearfix">
        <ektronUI:Label ID="uxPaymentGatewayIdLabel" AssociatedControlID="uxPaymentGatewayId" CssClass="span-3 last" runat="server" Text="* GatewayId:" />
        <ektronUI:TextField  ID="uxPaymentGatewayId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>    
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="SetDefault"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            PaymentGatewayManager paymentGatewayManager = new PaymentGatewayManager();            
            long paymentGatewayId = long.Parse(uxPaymentGatewayId.Text);
            PaymentGatewayData paymentGatewayData=paymentGatewayManager.GetItem(paymentGatewayId);
            if (paymentGatewayData != null)
            {
                paymentGatewayManager.SetDefault(paymentGatewayId);
                MessageUtilities.UpdateMessage(uxMessage, "PaymentGateway " + paymentGatewayId + " is set as default payment gateway", Message.DisplayModes.Success );
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "PaymentGateway " + paymentGatewayId + " is does not exists", Message.DisplayModes.Information);
            }
           
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

Update

Update(Ektron.Cms.Commerce.PaymentGatewayData)

Update the existing PaymentGatewayData object.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID
  • * Name
  • User ID
  • Password
  • Is Default

Parameters

Returns

Payment gateway data object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxPaymentGatewayIdLabel" AssociatedControlID="uxPaymentGatewayId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField  ID="uxPaymentGatewayId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>   
     <li class="clearfix">
        <ektronUI:Label ID="uxPaymentGatewayNameLabel" AssociatedControlID="uxPaymentGatewayName" CssClass="span-3 last" runat="server" Text="* Name:" />
        <ektronUI:TextField  ID="uxPaymentGatewayName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPaymentGatewayUserIdLabel" AssociatedControlID="uxPaymentGatewayUserId" CssClass="span-3 last" runat="server" Text=" User Id:" />
        <ektronUI:TextField  ID="uxPaymentGatewayUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
     <li class="clearfix">
        <ektronUI:Label ID="uxPaymentGatewayPasswordLabel" AssociatedControlID="uxPaymentGatewayPassword" CssClass="span-3 last" runat="server" Text=" Password:" />
        <ektronUI:TextField  ID="uxPaymentGatewayPassword" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>        
    <li class="clearfix">
        <ektronUI:Label ID="uxPaymentGatewayDefaultLabel" AssociatedControlID="uxPaymentGatewayDefault" CssClass="span-3 last" runat="server" Text=" IsDefault:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxPaymentGatewayDefault" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>   
     <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            PaymentGatewayManager paymentGatewayManager = new PaymentGatewayManager();
            bool isDefault = false;
            if(uxPaymentGatewayDefault.Checked) 
            {
                isDefault  = true ;
            }
            long paymentGatewayId=long.Parse(uxPaymentGatewayId.Text);
            PaymentGatewayData paymentGatewayData = paymentGatewayManager.GetItem(paymentGatewayId);
            if (paymentGatewayData != null)
            {
                paymentGatewayData.UserId = uxPaymentGatewayUserId.Text;
                paymentGatewayData.Password = uxPaymentGatewayPassword.Text;
                paymentGatewayData.Name = uxPaymentGatewayName.Text;
                paymentGatewayData.IsDefault = isDefault;
                paymentGatewayData=paymentGatewayManager.Update(paymentGatewayData);
                
                MessageUtilities.UpdateMessage(uxMessage, "PaymentGateway updated with Id " + paymentGatewayData.Id, Message.DisplayModes.Success);                
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "PaymentGateway details doesn't exists", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

Data Classes

PaymentGatewayCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • PaymentGatewayCriteria()
    public PaymentGatewayCriteria()
  • PaymentGatewayCriteria(Ektron.Cms.Commerce.PaymentGatewayProperty, EkEnumeration.OrderByDirection)
    public PaymentGatewayCriteria(Ektron.Cms.Commerce.PaymentGatewayProperty orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the PaymentGatewayProperty are:

    • AllowsCheckPayments
    • Id
    • IsDefault
    • Name

PaymentGatewayData

Namespace

Ektron.Cms.Commerce

Properties

  • AllowsCheckPayments. Gets or sets whether the payment gateway accepts check payments. * True = the payment gateway accepts check payments * False = the payment gateway does not accept check payments
    public bool AllowsCheckPayments { set; get; }
  • AllowsCreditCardPayments. Gets or sets whether the payment gateway accepts credit cards. * True = the payment gateway accepts credit cards * False = the payment gateway does not accept credit cards
    public bool AllowsCreditCardPayments { set; get; }
  • CustomFieldOne. Gets or sets the first custom field a payment gateway might require. Each type of payment gateway provider accepts configuration parameters. For example, Authorize.NET requires a username and password while PayFlow requires a username, password, vendor, and partner. So, if you were creating an object for PayFlow, you would enter the required vendor information in this property. If your payment gateway does not require additional information, leave blank.
    public string CustomFieldOne { set; get; }
  • CustomFieldTwo. Gets or sets the second custom field a payment gateway might require. Each type of payment gateway provider accepts configuration parameters. For example, Authorize.NET requires a username and password while PayFlow requires a username, password, vendor, and partner. So, if you were creating an object for PayFlow, you would enter the required partner information in this property. If your payment gateway does not require additional information, leave blank.
    public string CustomFieldTwo { set; get; }
  • Id. Gets or sets the Ektron CMS ID for the payment gateway data object. You cannot set the ID of a newly created data object. The ID of an object is set internally by Ektron CMS during the creation (Add) process. You can set the ID of the object for updating purposes.
    public long Id { set; get; }
  • IsCustom. Gets or sets whether this payment gateway is a custom payment gateway or one that comes pre-installed with Ektron CMS. Set this property to true when creating a custom payment gateway. * True = is a custom payment gateway * False = is not a custom payment gateway
    public bool IsCustom { set; get; }
  • IsDefault. Gets or sets whether this payment gateway is the default in Ektron CMS. * True = default payment gateway * False = not the default payment gateway.
    public bool IsDefault { set; get; }
  • Name. Gets or sets the name associated with the payment gateway. For example, if you were adding information for a payment gateway company called EkPay, enter "EkPay" for this property. When creating a payment gateway, a name value is required.
    public string Name { set; get; }
  • Password. Gets or sets the password associated with a payment gateway. This is not an Ektron CMS password. This information is supplied by the payment gateway.
    public string Password { set; get; }
  • PaymentGatewayData()
    public PaymentGatewayData()
  • PaymentGatewayData(string, string, string, string, string, bool, bool, bool)
    public PaymentGatewayData(string name, string user, 
  string password, string custom1, string custom2, 
  bool isDefault, bool allowsCreditCards, bool allowsChecks)
  • UserId. Gets or sets the user ID associated with a payment gateway. This is not an Ektron CMS user ID. This information is supplied by the payment gateway.
    public string UserId { set; get; }
  • Validate(). Validates the PaymentGatewayData object is valid for saving. Returns a ValidationResult object with any validation errors.
    public ValidationResults Validate()