StarlingBank 1.0.0

dotnet add package StarlingBank --version 1.0.0
NuGet\Install-Package StarlingBank -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="StarlingBank" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add StarlingBank --version 1.0.0
#r "nuget: StarlingBank, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install StarlingBank as a Cake Addin
#addin nuget:?package=StarlingBank&version=1.0.0

// Install StarlingBank as a Cake Tool
#tool nuget:?package=StarlingBank&version=1.0.0

Getting started

This is an unofficial C# .NET Standard SDK for Starling Bank's API. Starling's API enables seamless integration of Starling account and transactional data into your application. You can, subject to permission, use it to view account holder data and to automate actions on their accounts.

Before using the SDK, please follow the steps defined at Getting started (https://developer.starlingbank.com/get-started)

Initialization

Authentication

In order to setup authentication and initialization of the API client, you need the following information.

Parameter Description
oAuthAccessToken OAuth 2.0 Access Token

API client can be initialized as following.

// Configuration parameters and credentials
string oAuthAccessToken = "oAuthAccessToken"; // OAuth 2.0 Access Token
StarlingBank client = new StarlingBank(StarlingBank.Configuration.Environments.SANDBOX, oAuthAccessToken);

Class Reference

List of Singleton Instance

  • Webhooks
  • Accounts
  • Businesses
  • IndividualsAndSoleTraders
  • JointAccounts
  • SoleTraders
  • SpendingInsights
  • AccountHolders
  • ProfileImages
  • Addresses
  • Cards
  • Recurring
  • DirectDebitMandates
  • TransactionFeed
  • FeedRoundUp
  • APIUserIdentities
  • KYC
  • Payments
  • Onboarding
  • Payees
  • SavingsGoals
  • SettleUp
  • Subscriptions

Example of using the Accounts singleton instance

The singleton instance of the AccountsController class can be accessed from the API Client.

IAccountsController accounts = client.Accounts;

StarlingBank.Controllers.AccountsController.GetAccounts

This endpoint lists an account holder's bank accounts. An account holder, such as a PCA (a personal current account - which should really be thought of as a personal current account holder), may have many accounts, such as a personal GBP and personal EUR account. This is different from the idea of an individual (a human/natural person), and is different from a person (a natural (human)/legal (company) person).

Categories are subdivisions within an account. The defaultCategory from /api/v2/accounts is where the main balance and transactions are held. Other categories are used for Savings Goals.

Task<StarlingBank.Models.Accounts> GetAccounts()
Example Usage

StarlingBank.Models.Accounts myAccounts = await accounts.GetAccounts();
foreach (var myAccount in myAccounts.AccountsProp)
{
      Debug.WriteLine("My account balance is " + myAccount.Amount.MinorUnits);
}

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 421 8/19/2020