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

    Class ScraperJson

    Utility methods for converting between SEPA classes and their SUPA/JSON representation.

    Inheritance
    System.Object
    ScraperJson
    Inherited Members
    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.Scraper
    Assembly: Subsembly.Scraper.dll
    Syntax
    public static class ScraperJson
    Remarks

    The field names of the JSON objects are based on the XML tag names defined in the Subsembly SUPA specification based on ISO 20022. Hence, it should be straightforward to understand and apply.

    Methods

    ConvertAccount(JsonObject)

    Creates a new, fully initialized SepaAccount instance from the given JSON account data.

    Declaration
    public static SepaAccount ConvertAccount(JsonObject jsAccount)
    Parameters
    Type Name Description
    JsonObject jsAccount
    Returns
    Type Description
    SepaAccount
    Remarks

    This will throw an exception if the given jsAccount contains syntactically invalid values e.g. for IBAN, BIC or Currency. The method does not validate the completeness of the account information.

    ConvertAccount(SepaAccount)

    Declaration
    public static JsonObject ConvertAccount(SepaAccount aAccount)
    Parameters
    Type Name Description
    SepaAccount aAccount
    Returns
    Type Description
    JsonObject

    ConvertBalance(JsonObject)

    Declaration
    public static SepaBalance ConvertBalance(JsonObject jsBalance)
    Parameters
    Type Name Description
    JsonObject jsBalance
    Returns
    Type Description
    SepaBalance

    ConvertBalance(SepaBalance)

    Declaration
    public static JsonObject ConvertBalance(SepaBalance aBalance)
    Parameters
    Type Name Description
    SepaBalance aBalance
    Returns
    Type Description
    JsonObject

    ConvertResult(JsonObject)

    Declaration
    public static ScraperResult ConvertResult(JsonObject jsRes)
    Parameters
    Type Name Description
    JsonObject jsRes
    Returns
    Type Description
    ScraperResult
    Exceptions
    Type Condition
    System.ArgumentNullException

    The parameter was null.

    See Also
    ConvertResult(ScraperResult)

    ConvertResult(ScraperResult)

    Converts a ScraperResult into JSON representation.

    Declaration
    public static JsonObject ConvertResult(ScraperResult aRes)
    Parameters
    Type Name Description
    ScraperResult aRes

    The result to be converted. Must not be null.

    Returns
    Type Description
    JsonObject

    Returns a JSON object with the data elements Code, Text (optional), and Trace (optional). The Code contains the numeric value of the Code property. The Text contains the value from the DisplayText property. The Trace contains the UTF8 and Base64 encoded value from the DiagnosticTrace.

    Exceptions
    Type Condition
    System.ArgumentNullException

    The parameter was null.

    See Also
    ConvertResult(JsonObject)

    ConvertStatement(SepaDocument)

    Converts a CAMT document into JSON representation.

    Declaration
    public static JsonObject ConvertStatement(SepaDocument aDoc)
    Parameters
    Type Name Description
    SepaDocument aDoc
    Returns
    Type Description
    JsonObject
    Exceptions
    Type Condition
    System.ArgumentNullException

    The parameter was null.

    System.ArgumentException

    The given document was not CAMT document.

    System.NotSupportedException

    The CAMT document did not contain a single statement only.

    ConvertStatement(SepaStatement)

    Converts a SepaStatement instance into JSON representation.

    Declaration
    public static JsonObject ConvertStatement(SepaStatement aStmt)
    Parameters
    Type Name Description
    SepaStatement aStmt
    Returns
    Type Description
    JsonObject

    ConvertStatementEntry(SepaStatementEntry)

    Creates a JSON object for the given SepaStatementEntry.

    Declaration
    public static JsonObject ConvertStatementEntry(SepaStatementEntry aEntry)
    Parameters
    Type Name Description
    SepaStatementEntry aEntry
    Returns
    Type Description
    JsonObject
    Remarks

    A single SepaStatementEntry without any SepaTransactionDetails.

    ConvertStatementEntry(SepaStatementEntry, SepaTransactionDetails)

    Creates a JSON object for the given CAMT transaction details.

    Declaration
    public static JsonObject ConvertStatementEntry(SepaStatementEntry aEntry, SepaTransactionDetails aTxn)
    Parameters
    Type Name Description
    SepaStatementEntry aEntry
    SepaTransactionDetails aTxn
    Returns
    Type Description
    JsonObject
    Remarks

    A single SepaStatementEntry may contain multiple SepaTransactionDetails or none at all. In order to convert the complete statement entry, this method must be invoked for every SepaTransactionDetails instance.

    In This Article
    Back to top Copyright 2009-2025 Subsembly GmbH