PRIMAVERA | Developers

    Show / Hide Table of Contents

    Class StdBSPaymentManager

    This class manages the operations required to manage payments.

    Inheritance
    System.Object
    StdBSBaseService
    StdBSPaymentManager
    Implements
    System.IDisposable
    Inherited Members
    StdBSBaseService.m_objBSO
    StdBSBaseService.BSO
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: StdPlatBS100
    Assembly: StdPlatBS100.dll
    Syntax
    [Guid("9E981969-84F4-4E34-AEBC-D54DA498CD63")]
    public class StdBSPaymentManager : StdBSBaseService, IDisposable

    Constructors

    StdBSPaymentManager()

    Declaration
    public StdBSPaymentManager()

    Properties

    PaymentsActive

    Check if payments are active for the actual subscription.

    Declaration
    public bool PaymentsActive { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    Dispose()

    Declaration
    public void Dispose()

    Dispose(Boolean)

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    ExecutePayment(String)

    Executes a payment request.

    Declaration
    public StdBEPayment ExecutePayment(string paymentId)
    Parameters
    Type Name Description
    System.String paymentId
    Returns
    Type Description
    StdBEPayment

    The payment object

    GetLatestPaymentInformation(String)

    Retrives a payment from the gateway service using its id.

    Declaration
    public StdBEPayment GetLatestPaymentInformation(string paymentId)
    Parameters
    Type Name Description
    System.String paymentId
    Returns
    Type Description
    StdBEPayment

    GetPayment(String)

    Retrieves a payment from the database using its id.

    Declaration
    public StdBEPayment GetPayment(string paymentId)
    Parameters
    Type Name Description
    System.String paymentId

    The payment id.

    Returns
    Type Description
    StdBEPayment

    GetPaymentProviders(Boolean, Boolean, String, String)

    Retrieves the configuration methods available.

    Declaration
    public IList<StdBEPaymentProvider> GetPaymentProviders(bool refreshFromGateway = false, bool referenceOnly = false, string countryFilter = "", string currencyFilter = "")
    Parameters
    Type Name Description
    System.Boolean refreshFromGateway
    System.Boolean referenceOnly
    System.String countryFilter
    System.String currencyFilter
    Returns
    Type Description
    System.Collections.Generic.IList<StdBEPaymentProvider>

    IsPaymentMethodPossible(StdBEPaymentProvider, String, Double)

    Returns if a payment method is possible in the context of a specific document (by its currency and value)

    Declaration
    public bool IsPaymentMethodPossible(StdBEPaymentProvider provider, string currency, double value)
    Parameters
    Type Name Description
    StdBEPaymentProvider provider
    System.String currency
    System.Double value
    Returns
    Type Description
    System.Boolean

    IsPaymentPossible(String, String, Double)

    Returns if there is at least one payment method that allows the payment of a specific document (by its currency and value)

    Declaration
    public bool IsPaymentPossible(string providerId, string currency, double value)
    Parameters
    Type Name Description
    System.String providerId
    System.String currency
    System.Double value
    Returns
    Type Description
    System.Boolean

    PostPaymentConfigurationRequest(IList<StdBEPaymentProvider>)

    Posts the configuration for one or more payment methods.

    Declaration
    public StdBEPaymentConfigurationResponse PostPaymentConfigurationRequest(IList<StdBEPaymentProvider> configRequest)
    Parameters
    Type Name Description
    System.Collections.Generic.IList<StdBEPaymentProvider> configRequest
    Returns
    Type Description
    StdBEPaymentConfigurationResponse

    PostPaymentRequest(StdBEPaymentRequest)

    Creates a new payment

    Declaration
    public StdBEPayment PostPaymentRequest(StdBEPaymentRequest paymentRequest)
    Parameters
    Type Name Description
    StdBEPaymentRequest paymentRequest
    Returns
    Type Description
    StdBEPayment

    Implements

    System.IDisposable