Webiant Logo Webiant Logo
☌

  1. No results found.

    Try your search with a different keyword or use * as a wildcard.

ProcessPaymentRequest.cs

using Nop.Core.Domain.Catalog;
using Nop.Core.Domain.Orders;
using Nop.Services.Orders;

namespace Nop.Services.Payments;

/// <summary>
/// Represents a payment info holder
/// </summary>
public partial class ProcessPaymentRequest
{
    public ProcessPaymentRequest()
    {
        CustomValues = new CustomValues();
        OrderGuid = Guid.NewGuid();
        OrderGuidGeneratedOnUtc = DateTime.UtcNow;
    }

    /// <summary>
    /// Gets or sets a store identifier
    /// </summary>
    public int StoreId { get; set; }

    /// <summary>
    /// Gets or sets a customer identifier
    /// </summary>
    public int CustomerId { get; set; }

    /// <summary>
    /// Gets or sets an order unique identifier. Used when order is not saved yet (payment gateways that do not redirect a customer to a third-party URL)
    /// </summary>
    public Guid OrderGuid { get; set; }

    /// <summary>
    /// Gets or sets a datetime when "OrderGuid" property was generated (used for security purposes)
    /// </summary>
    public DateTime? OrderGuidGeneratedOnUtc { get; set; }

    /// <summary>
    /// Gets or sets an order total
    /// </summary>
    public decimal OrderTotal { get; set; }

    /// <summary>
    /// /// <summary>
    /// Gets or sets a payment method identifier
    /// </summary>
    /// </summary>
    public string PaymentMethodSystemName { get; set; }

    #region Payment method specific properties 

    /// <summary>
    /// Gets or sets a credit card type (Visa, Master Card, etc...). We leave it empty if not used by a payment gateway
    /// </summary>
    public string CreditCardType { get; set; }

    /// <summary>
    /// Gets or sets a credit card owner name
    /// </summary>
    public string CreditCardName { get; set; }

    /// <summary>
    /// Gets or sets a credit card number
    /// </summary>
    public string CreditCardNumber { get; set; }

    /// <summary>
    /// Gets or sets a credit card expire year
    /// </summary>
    public int CreditCardExpireYear { get; set; }

    /// <summary>
    /// Gets or sets a credit card expire month
    /// </summary>
    public int CreditCardExpireMonth { get; set; }

    /// <summary>
    /// Gets or sets a credit card CVV2 (Card Verification Value)
    /// </summary>
    public string CreditCardCvv2 { get; set; }

    #endregion

    #region Recurring payments

    /// <summary>
    /// Gets or sets an initial (parent) order identifier if order is recurring
    /// </summary>
    public Order InitialOrder { get; set; }

    /// <summary>
    /// Gets or sets the cycle length
    /// </summary>
    public int RecurringCycleLength { get; set; }

    /// <summary>
    /// Gets or sets the cycle period
    /// </summary>
    public RecurringProductCyclePeriod RecurringCyclePeriod { get; set; }

    /// <summary>
    /// Gets or sets the total cycles
    /// </summary>
    public int RecurringTotalCycles { get; set; }

    #endregion

    /// <summary>
    /// You can store any custom value in this property
    /// </summary>
    public CustomValues CustomValues { get; set; }
}