victor-david / restless-ofxsharper

Provides extended Ofx services: parsing of multiple statements, closing statements, financial institution profile info; and Ofx request building.

Restless OfxSharper

Provides extended Ofx services: parsing of multiple statements, closing statements, financial institution profile info; and Ofx request building.

Main Features

• Build an Ofx request for a financial institution profile (what types of online services it supports) and transform the response into a usuable object.

• Build an Ofx request for an account statement (or multiple statements) and transform the resulting response. Request and response can include account closing statements as well.

Code Samples

The following code samples demonstrate a few common scenarios.

Get FI Profile

public void OfxProfileExample()
{
    // You need to get your own bank details into an IBank object.
    IBank bank = GetMyBankInfo();

    var builder = OfxFactory.Builder.Create();

    builder.BuildOfxRequest(() =>
    {
        builder.Signon.BuildMessageSet(bank);
        builder.Profile.BuildMessageSet();
    });

    // Send request to the bank and get the response
    string response = GetResponseFromBank(builder.RequestText);
    // Transform response string. Ready to go.
    OfxProfileResponse profile = OfxFactory.ProfileResponse.Create(response);
    // Do something.
    if (profile.BillPay.CanAddPayee)
    {
    }
}

Bank Statement Download

public void BankStatementDownload()
{
    // You need to get your own bank details into an IBank object.
    IBank bank = GetMyBankInfo();
    // You need to get your own account details into an IAccount object.
    IAccount account = GetMyAccountInfo();

    OfxRequestBuilder builder = OfxFactory.Builder.Create();
    builder.BuildOfxRequest(() =>
    {
        builder.Signon.BuildMessageSet(bank);

        builder.Bank.BuildMessageSet(() =>
        {
            // in your app, you'd have to determine an appropiate date to start with.
            DateTime fromDate = new DateTime(2018, 1, 1);
            builder.Bank.BuildStatementRequest(account, fromDate, null, true);
            // add another statement request if you've got another account at the same bank
        });
    });

    // Send request to the bank and get the response
    string response = GetResponseFromBank(builder.RequestText);

    // Transform response string. Ready to go.
    OfxResponse ofx = OfxFactory.Response.Create(response);
}

Credit Card Statement Download (with closing statements)

public void CreditCardStatementDownload()
{
    // You need to get your own bank details into an IBank object.
    IBank bank = GetMyBankInfo();
    // You need to get your own account details into an IAccount object.
    IAccount account = GetMyAccountInfo();

    OfxRequestBuilder builder = OfxFactory.Builder.Create();
    builder.BuildOfxRequest(() =>
    {
        builder.Signon.BuildMessageSet(bank);

        builder.CreditCard.BuildMessageSet(() =>
        {
            // in your app, you'd have to determine an appropiate date to start with
            DateTime dateStart = new DateTime(2018, 1, 1);
            builder.CreditCard.BuildStatementRequest(account, dateStart, null, true);
            // Not using a start date or an end date. Bank will deliver whatever they've got.
            builder.CreditCard.BuildClosingStatementRequest(account, null, null);
        });
    });

    // Send request to the bank and get the response
    string response = GetResponseFromBank(builder.RequestText);

    // Transform response string. Ready to go.
    OfxResponse ofx = OfxFactory.Response.Create(response);
    if (ofx.Bank.Statements.Count == 1)
    {
        foreach (var closingPeriod in ((CreditCardStatement)ofx.Bank.Statements[0]).Closing.Periods)
        {
            // do something
        }
    }
}

Bank and Credit Card Statement Download

public void BankAndCreditCardStatementDownload()
{
    // You need to get your own bank details into an IBank object.
    IBank bank = GetMyBankInfo();
    // You need to get your own account details into an IAccount object.
    IAccount bankAccount = GetMyAccountInfo();
    IAccount creditCardAccount = GetMyAccountInfo();

    OfxRequestBuilder builder = OfxFactory.Builder.Create();
    builder.BuildOfxRequest(() =>
    {
        builder.Signon.BuildMessageSet(bank);

        builder.Bank.BuildMessageSet(() =>
        {
            // in your app, you'd have to determine an appropiate date to start with.
            DateTime fromDate = new DateTime(2018, 1, 1);
            builder.Bank.BuildStatementRequest(bankAccount, fromDate, null, true);
        });

        builder.CreditCard.BuildMessageSet(() =>
        {
            // in your app, you'd have to determine an appropiate date to start with
            DateTime dateStart = new DateTime(2018, 1, 1);
            builder.CreditCard.BuildStatementRequest(creditCardAccount, dateStart, null, true);
            // Not using a start date or an end date. Bank will deliver whatever they've got.
            builder.CreditCard.BuildClosingStatementRequest(creditCardAccount, null, null);
        });
    });

    // Send request to the bank and get the response
    string response = GetResponseFromBank(builder.RequestText);

    // Transform response string. Ready to go.
    OfxResponse ofx = OfxFactory.Response.Create(response);
    foreach (var statement in ofx.Bank.Statements)
    {
        if (statement.StatementType == StatementType.Bank)
        {
            // do something
        }
        if (statement.StatementType == StatementType.CreditCard)
        {
            // do something
        }
    }
}