Alex Peters > Finance-Bank-Bankwest-1.2.6 > Finance::Bank::Bankwest::SessionFromLogin

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

Dependencies

Annotate this POD

Website

CPAN RT

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

NAME ^

Finance::Bank::Bankwest::SessionFromLogin - create a session using a PAN and access code

VERSION ^

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

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

SYNOPSIS ^

    my $from_login = Finance::Bank::Bankwest::SessionFromLogin->new(
        pan         => 12345678,
        access_code => 'LetMeIn123',
    );
    # returns a Finance::Bank::Bankwest::Session object
    my $session = $from_login->session;

DESCRIPTION ^

This module logs into Bankwest Online Banking using a supplied PAN (Personal Access Number) and access code, and sets up a Finance::Bank::Bankwest::Session object with the newly-created session.

"login" in Finance::Bank::Bankwest provides a slightly more convenient wrapper for this functionality.

ATTRIBUTES ^

pan

The Personal Access Number (PAN). Required.

access_code

The access code associated with the provided PAN. Required.

session

If login with the provided credentials is successful, a Finance::Bank::Bankwest::Session instance.

May throw one of the following exceptions on failure:

Finance::Bank::Bankwest::Error::NotLoggedIn::BadCredentials

if the remote server rejects the supplied PAN/access code combination.

Finance::Bank::Bankwest::Error::NotLoggedIn::UnknownReason

or

Finance::Bank::Bankwest::Error::BadResponse

if the remote server returns something unexpected, such as an "offline for maintenance" message or some sort of intermediate advertising pop-up. In both cases the remote server's response is available as an HTTP::Response object; see "response" in Finance::Bank::Bankwest::Error::WithResponse.

login_uri

The location of the resource that accepts the provided PAN and access code and establishes the banking session. Use the default value during normal operation.

SEE ALSO ^

AUTHOR ^

Alex Peters <lxp@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 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: