Going.Plaid

What is Going.Plaid?

Going.Plaid is a library for interacting with Plaid's banking APIs. See their documentation here. It is supported for .net standard 2.0, .net core 3.1, and .net 5.0+.

Where can I get it?

Going.Plaid is available at nuget.org.

Package Manager PM > Install-Package Going.Plaid

How it works?

You can make all calls to Plaid's API via the Going.Plaid.PlaidClient class.

var client = new PlaidClient(
	Environment.Sandbox);

// Retrieving a user's recent transactions.
var result = await client.TransactionsGetAsync(
	new()
	{
		Secret = "<secret>",
		ClientId = "<client_id>",
		AccessToken = "<access_token>",
	});

Usage

You may provide secret and clientId to the constructor as follows:

var client = new PlaidClient(
	Environment.Sandbox,
	secret: "<secret>",
	clientId: "<client_id>");

// Retrieving a user's recent transactions.
var result = await client.TransactionsGetAsync(
	new()
	{
		AccessToken = "<access_token>",
	});

This will allow you to save a single PlaidClient in the DI system without tracking secret and clientId separately. PlaidClient is comfortable being used as a single-instance class in this manner.

Example

Please visit this repo and download to review a working example of how to use this library and the Plaid API.

.NET Core Configuration Options

Easy to use:

Call services.AddPlaid(IConfigurationRoot) or services.AddPlaid(IConfiguration). This will automatically bind options from the provided configuration section or the Plaid section of the root; configure a named HttpClient for Going.Plaid; and configure PlaidClient as a singleton.

IHttpClientFactory

Going.Plaid supports the IHttpClientFactory for correct usage of HttpClient, as described here. If you choose not to call .AddPlaid(), because you need to customize your DI structure, it is recommended that you call services.AddPlaidClient() to properly configure the IHttpClientFactory for Going.Plaid usage.

`IOptions` Support

Going.Plaid supports configuration from any configuration source via the IOptions pattern. You can provide any configuration section to .AddPlaid() and the options will be automatically bound. Alternatively, you may call services.Configure<PlaidOptions>(); to configure the PlaidOption manually. Once done, you can then add PlaidClient as a singleton by calling services.AddSingleton<PlaidClient>().

Converters Support

There are several converters that Going.Plaid uses to serialize and deserialize data to the Plaid service. These converters are automatically used internally for all api calls to Plaid. However, if you need to do any serialization or deserialization of your own (for example, if you wish to pass Going.Plaid.Link.OnSuccessMetadata directly from the browser to the web server), then you may need to add these converters to the ASP.NET JSON serializer. The easiest way to do this is as follows:

services.Configure<JsonOptions>(o =>
{
	o.SerializerOptions.AddPlaidConverters();
});

This will automatically add the converters to the default options for ASP.NET JSON serializer. Otherwise, you can manually add the types found under Going.Plaid.Converters to the JsonSerializationOptions.Converters list of converters.

API Version

Going.Plaid currently targets Plaid API version 2020-09-14 only.

viceroypenguin/Going.Plaid