Updated: 31 Aug 2020 v1.0.1 released with new cmdlets for new API's to both GitHub and the PowerShell Gallery. - Get-UpBankCategories - Get-UpBankCategory - Get-UpBankTags
Banking is undergoing a revolution. In Australia the rise of Neo Banks is really starting to get momentum and one of the first entrants was Up. With a target demographic of Digital Natives, initially the services offered were foundational. But as a customer over the last 18 months, I’ve personally seen the functionality increase with fantastic cadence. To much acclaim they’ve also been very transparent with their feature road map as shown here. This week they announced the first release of their customer API. As a happy customer that prompted me to publish the first release of my Up Bank PowerShell Module. The Up Bank PowerShell Module joins others I’ve recently published.
My Up Bank PowerShell Module is open source with the source available on GitHub here. This first release provides the core functionality matches with the initial release of the Up Bank customer API.
The Up Bank PowerShell Module can be installed from the PowerShell Gallery on Windows PowerShell 5.1+, PowerShell Core 6.x or PowerShell. The module is therefore supported cross platform (Mac, Windows, Linux).
Install-Module -name UpBank
The module currently contains 9 cmdlets;
The module supports multiple sets of credentials. One set can be set as default (see Save-UpBankCredential) and will be automatically and securely loaded when the module loads. This avoids having to set the credentials every-time.
Set-UpBankCredential needs to be passed a PowerShell Credential object. This can be generated using Get-Credential. The value provided for User (when using get-credential) is used as the profile name. Generate your Personal Access Token here.
$myUpBankCredentials = Get-Credential Set-UpBankCredential -credential $myUpBankCredentials
Securely save credentials for an Up Bank user to the configuration file.
The optional –default switch means this profile will be automatically loaded next time the Up Bank PowerShell Module is loaded. Use Switch-UpBankProfile to switch to another Profile.
Save-UpBankConfiguration -default
The Up Bank PowerShell Module allows multiple account profiles to be configured.
When using Set-UpBankCredential the value provided for User (when using get-credential) is used as the profile name. The Switch-UpBankProfile cmdlet can be used to switch profiles.
Switch-UpBankProfile -profile Darren
Below is an example to switch the current configuration to a profile named Kate and make it the new default profile. The Kate profile will then be loaded automatically the next time the module is loaded.
Switch-UpBankProfile -profile Kate -default
The following command can be used to see what profiles are stored in the Up Bank Configuration file.
Note: The PersonalAccessTokens are encrypted and the configuration file can not be used outside of the users profile that created the configuration.
$configFile = Join-Path $env:LOCALAPPDATA UpBankConfiguration.clixml import-clixml $configFile
The Test-UpBankAPI cmdlet is used to test to see if the currently loaded credentials are valid.
Test-UpBankAPI
List Up Bank Accounts
Query and return all Up Bank Accounts.
$myAccounts = Get-UpBankAccounts Write-Host -ForegroundColor Green "$($myAccounts.count) account(s) found." foreach ($account in $myAccounts) { Write-Host -ForegroundColor Blue " $($account.attributes.displayName)" }
Query and return the details for a specific Up Bank Account
Get-UpBankAccount -id $myAccounts[0].id
Return the most recent transactions (defaults to 100) across all accounts.
Get-UpBankTransactions
Query and return the most recent 200 transactions across all accounts.
Get-UpBankTransactions -pageSize 200
Get the last transactions (defaults to max 100) since 27 July 2020 09:07:54 Australian Eastern Time.
Get-UpBankTransactions -since 2020-07-27T09:07:54+10:00
Get the last 10 transactions since 27 July 2020 09:07:54 Australian Eastern Time.
Get-UpBankTransactions -pageSize 10 -since 2020-07-27T09:07:54+10:00
(Get-UpBankTransactions -pageSize 1).attributes
Query the most recent transaction(s) (defaults to max 100) on a specific account.
$myAccounts = Get-UpBankAccounts Get-UpBankAccountTransactions -accountID $myAccounts[0].id
Query and return the most recent 201 transactions on an account.
$myAccounts = Get-UpBankAccounts Get-UpBankAccountTransactions -accountID $myAccounts[0].id -pageSize 201
Return the last 10 transactions since 27 May 2020 09:07:54 Australian Eastern Time from a specific account.
Get-UpBankAccountTransactions -accountID $myAccounts[1].id -since 2020-05-27T09:07:54+10:00 -pageSize 10
Return the last (defaults to 100) transactions since 27 July 2020 01:02:03 Australian Eastern Time from a specific account.
Get-UpBankAccountTransactions -accountID $myAccounts[1].id -until 2020-07-27T01:02:03+10:00
A few weeks back the Microsoft AI Tour was in Sydney Australia. There was a…
If you're anything like me you always have PowerShell open, and often both PowerShell and…
Decentralised Identity is a technology I'm passionate about and have written many posts and tools…
Over two years ago I authored a PowerShell Module that enabled the automation of 1Password.…
Buried in my PowerShell Snippets Vol 4 post from 2021 is the PowerShell script and…
Short post on how to recovery from "The Windows Subsystem for Linux instance has terminated"…
This website uses cookies.