• API Overview
  • EBICS API
  • FinTS API
  • XS2A API
  • SEPA API
Search Results for

    Class EbicsRequest

    Represents an EBICS request message.

    Inheritance
    System.Object
    EbicsElement
    EbicsMessage
    EbicsRequest
    Inherited Members
    EbicsMessage.Version
    EbicsMessage.RootTag
    EbicsMessage.AuthSignature
    EbicsMessage.TransactionPhase
    EbicsMessage.NumSegments
    EbicsMessage.SegmentNumber
    EbicsMessage.LastSegment
    EbicsMessage.DataTransfer
    EbicsMessage.CreateMessage(String)
    EbicsMessage.CreateMessage(XmlDocument)
    EbicsMessage.BuildMessage(EbicsVersion, IEbicsSecurityOperations, EbicsSecurityCode)
    EbicsMessage.ParseMessage(XmlDocument)
    EbicsMessage.VerifyAuthSignature(EbicsPubKeyInfo)
    EbicsMessage.BuildXml(XmlDocument, EbicsVersion)
    EbicsMessage.ParseXml(XmlElement, EbicsVersion)
    EbicsElement.BuildXmlDocument(EbicsVersion)
    EbicsElement.Load(Stream, EbicsVersion)
    EbicsElement.Load(String, EbicsVersion)
    EbicsElement.Save(Stream, EbicsVersion)
    EbicsElement.Save(String, EbicsVersion)
    EbicsElement.FromBuffer(EbicsDataBuffer, EbicsVersion)
    EbicsElement.ToBuffer(EbicsVersion)
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Subsembly.EBICS
    Assembly: Subsembly.EBICS.Core.dll
    Syntax
    public class EbicsRequest : EbicsMessage

    Constructors

    EbicsRequest(EbicsRequestType)

    Declaration
    public EbicsRequest(EbicsRequestType nRequestType)
    Parameters
    Type Name Description
    EbicsRequestType nRequestType

    Properties

    AdditionalOrderInfo

    Optional additional order information introduced with EBICS 3.0.

    Declaration
    public string AdditionalOrderInfo { get; set; }
    Property Value
    Type Description
    System.String

    AdminOrderType

    Since EBICS 3.0 the AdminOrderType is mandatory inside the OrderDetails element. For EBICS 2.x it is ignored and the OrderType is used instead.

    Declaration
    public string AdminOrderType { get; set; }
    Property Value
    Type Description
    System.String

    BankAuthenticationPubKeyDigest

    Declaration
    public EbicsPubKeyDigest BankAuthenticationPubKeyDigest { get; set; }
    Property Value
    Type Description
    EbicsPubKeyDigest

    BankEncryptionPubKeyDigest

    Declaration
    public EbicsPubKeyDigest BankEncryptionPubKeyDigest { get; set; }
    Property Value
    Type Description
    EbicsPubKeyDigest

    HostID

    Declaration
    public string HostID { get; set; }
    Property Value
    Type Description
    System.String

    Nonce

    Declaration
    public string Nonce { get; }
    Property Value
    Type Description
    System.String

    OrderAttribute

    Declaration
    public string OrderAttribute { get; set; }
    Property Value
    Type Description
    System.String
    Remarks

    Mandatory with EBICS 2.x, no longer existing since EBICS 3.0.

    OrderID

    Declaration
    public string OrderID { get; set; }
    Property Value
    Type Description
    System.String

    OrderParams

    Any EbicsOrderParams implementation that holds the order parameters.

    Declaration
    public EbicsOrderParams OrderParams { get; set; }
    Property Value
    Type Description
    EbicsOrderParams
    Remarks

    Before EBICS 3.0, usually an instance of EbicsStandardOrderParams. Since EBICS 3.0, this is ususally an instance of EbicsBTDOrderParams, or EbicsBTUOrderParams. Note that the EbicsBTDOrderParams and EbicsBTUOrderParams implementation can feign a StandardOrderParams element when used with EBICS 2.x. Hence for compatibility with EBICS 2.x and EBICS 3.x one can always use the new EbicsBTDOrderParams and EbicsBTUOrderParams implementations, regardless of the actual EBICS version.

    OrderType

    OrderType

    Declaration
    public string OrderType { get; set; }
    Property Value
    Type Description
    System.String
    Remarks

    For EBICS 2.x the OrderType is mandatory. Since EBICS 3.0 this is fully ignored and the AdminOrderType is used instead.

    PartnerID

    Declaration
    public string PartnerID { get; set; }
    Property Value
    Type Description
    System.String

    Product

    Declaration
    public string Product { get; set; }
    Property Value
    Type Description
    System.String

    ProductInstituteID

    Declaration
    public string ProductInstituteID { get; set; }
    Property Value
    Type Description
    System.String

    ProductLanguage

    Declaration
    public string ProductLanguage { get; set; }
    Property Value
    Type Description
    System.String

    ReceiptCode

    The TransferReceipt ReceiptCode.

    Declaration
    public string ReceiptCode { get; set; }
    Property Value
    Type Description
    System.String

    If this is not set, then by default a success reeceipt code "0" will be included in the Receipt phase.

    RequestType

    Declaration
    public EbicsRequestType RequestType { get; }
    Property Value
    Type Description
    EbicsRequestType

    SecurityMedium

    Declaration
    public string SecurityMedium { get; set; }
    Property Value
    Type Description
    System.String

    SystemID

    Declaration
    public string SystemID { get; set; }
    Property Value
    Type Description
    System.String

    Timestamp

    Declaration
    public DateTime Timestamp { get; }
    Property Value
    Type Description
    System.DateTime

    TransactionID

    Declaration
    public string TransactionID { get; set; }
    Property Value
    Type Description
    System.String

    UserID

    Declaration
    public string UserID { get; set; }
    Property Value
    Type Description
    System.String

    Methods

    BuildBody(XmlElement, EbicsVersion)

    Declaration
    protected override void BuildBody(XmlElement xmlBody, EbicsVersion nVersion)
    Parameters
    Type Name Description
    System.Xml.XmlElement xmlBody
    EbicsVersion nVersion
    Overrides
    EbicsMessage.BuildBody(XmlElement, EbicsVersion)

    BuildHeaderMutable(XmlElement, EbicsVersion)

    Declaration
    protected override void BuildHeaderMutable(XmlElement xmlMutable, EbicsVersion nVersion)
    Parameters
    Type Name Description
    System.Xml.XmlElement xmlMutable
    EbicsVersion nVersion
    Overrides
    EbicsMessage.BuildHeaderMutable(XmlElement, EbicsVersion)

    BuildHeaderStatic(XmlElement, EbicsVersion)

    Declaration
    protected override void BuildHeaderStatic(XmlElement xmlStatic, EbicsVersion nVersion)
    Parameters
    Type Name Description
    System.Xml.XmlElement xmlStatic
    EbicsVersion nVersion
    Overrides
    EbicsMessage.BuildHeaderStatic(XmlElement, EbicsVersion)

    ParseBody(XmlElement, EbicsVersion)

    Declaration
    protected override void ParseBody(XmlElement xmlBody, EbicsVersion nVersion)
    Parameters
    Type Name Description
    System.Xml.XmlElement xmlBody
    EbicsVersion nVersion
    Overrides
    EbicsMessage.ParseBody(XmlElement, EbicsVersion)

    ParseHeaderMutable(XmlElement, EbicsVersion)

    Declaration
    protected override void ParseHeaderMutable(XmlElement xmlMutable, EbicsVersion nVersion)
    Parameters
    Type Name Description
    System.Xml.XmlElement xmlMutable
    EbicsVersion nVersion
    Overrides
    EbicsMessage.ParseHeaderMutable(XmlElement, EbicsVersion)

    ParseHeaderStatic(XmlElement, EbicsVersion)

    Declaration
    protected override void ParseHeaderStatic(XmlElement xmlStatic, EbicsVersion nVersion)
    Parameters
    Type Name Description
    System.Xml.XmlElement xmlStatic
    EbicsVersion nVersion
    Overrides
    EbicsMessage.ParseHeaderStatic(XmlElement, EbicsVersion)
    In This Article
    Back to top Copyright 2009-2025 Subsembly GmbH