Alex Peters > Finance-Bank-Bankwest-1.2.5 > Finance::Bank::Bankwest

Download:
Finance-Bank-Bankwest-1.2.5.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: v1.2.5   Source   Latest Release: Finance-Bank-Bankwest-1.2.7

NAME ^

Finance::Bank::Bankwest - check Bankwest accounts from Perl

VERSION ^

This module is part of distribution Finance-Bank-Bankwest v1.2.5.

This distribution's version numbering follows the conventions defined at semver.org.

SYNOPSIS ^

    my $session = Finance::Bank::Bankwest->login(
        pan         => 12345678,
        access_code => 'LetMeIn123',
    );
    for my $acct ($session->accounts) {
        printf(
            "Account %s has available balance %s\n",
            $acct->number,
            $acct->available_balance,
        );
        my @txns = $session->transactions(
            account     => $acct->number,
            from_date   => '31/12/2012',
        );
        for my $txn (@txns) {
            printf(
                "> Transaction: %s (%s)\n",
                $txn->narrative,
                $txn->amount,
            );
        }
    }
    $session->logout;

DESCRIPTION ^

This distribution provides the ability to log into Bankwest's Online Banking service using a Personal Access Number (PAN) and access code, then retrieve information on all accounts associated with that PAN and their transactions.

Consult the documentation for Finance::Bank::Bankwest::Session for further details on what can be achieved within a session.

WARNING ^

The code contained in this distribution is not endorsed by Bankwest as an official means of accessing banking data. It is entirely written and provided by a third party, and Bankwest will not provide support for this distribution if approached for it (see "SUPPORT").

You should audit the source code of this distribution in order to satisfy yourself that your banking details are only being used in a legitimate manner.

Consider also consulting the Bankwest Online Banking Conditions of Use before using this distribution.

METHODS ^

login

    $session = Finance::Bank::Bankwest->login(
        pan             => 12345678,        # required
        access_code     => 'LetMeIn123',    # required
    );

Log into Bankwest Online Banking with the supplied Personal Access Number (PAN) and access code. Returns a Finance::Bank::Bankwest::Session object on success.

Refer to "session" in Finance::Bank::Bankwest::SessionFromLogin for specific details on possible exceptions that may be thrown in cases of failure.

SEE ALSO ^

SUPPORT ^

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-finance-bank-bankwest at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Finance-Bank-Bankwest. You will be automatically notified of any progress on the request by the system.

Source Code

The source code for this distribution is available online in a Git repository. Please feel welcome to contribute patches.

https://github.com/lx/perl5-Finance-Bank-Bankwest

  git clone git://github.com/lx/perl5-Finance-Bank-Bankwest

AUTHOR ^

Alex Peters <lxp@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2013 by Alex Peters.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

The full text of the license can be found in the 'LICENSE' file included with this distribution.

syntax highlighting: