ApimaticplaidSDK 0.0.2

The Plaid API

The The Plaid API SDK for .NET provides access to the The Plaid API REST APIs from .NET applications.

The Plaid REST API. Please see https://plaid.com/docs/api for more details.

Installation

To add the .NET SDK to your project from NuGet:

dotnet add package ApimaticplaidSDK

To build against the SDK source instead, add it as a project reference into your solution:

dotnet add reference <path-to-sdk>/ThePlaidApi.csproj

Quick Start

Dependency Injection

Register the client with IServiceCollection and resolve it from the container. The HttpClient is managed by IHttpClientFactory. Configure the client's behavior through ThePlaidApiClientOptions.

services.AddThePlaidApiClient(options =>
{
    options.PlaidClientId = "YOUR_API_KEY";
    options.PlaidSecret = "YOUR_API_KEY";
    options.PlaidVersion = "YOUR_API_KEY";
    options.Environment = ServerEnvironment.Production;
    // TODO: configure more client options here
});

Direct Instantiation

Create the client by passing an HttpClient you manage yourself. Configure the client's behavior through ThePlaidApiClientOptions.

var httpClient = new HttpClient();
// TODO: configure more client options here
var options = new ThePlaidApiClientOptions
{
    PlaidClientId = "YOUR_API_KEY",
    PlaidSecret = "YOUR_API_KEY",
    PlaidVersion = "YOUR_API_KEY",
    Environment = ServerEnvironment.Production,
};
var client = new ThePlaidApiClient(httpClient, options);

Usage

For code examples and error responses, see API Reference.

Enums

Every enum the spec declares is a sealed record with one public static readonly member per value (VerificationRefreshStatus.VerificationRefreshStatusUserPresenceRequired), a JSON converter, and a Match that makes handling exhaustive: one on{Member} arm per known value, then otherwise, which receives the raw wire value the server sent when it is one this SDK does not declare.

var label =
    received.Match(
        onVerificationRefreshStatusUserPresenceRequired: () => "VerificationRefreshStatusUserPresenceRequired",
        otherwise: raw => $"undeclared ({raw})");

Prefer named arguments as above. The arms are positional, in the order the spec lists its values, and a regenerated SDK that adds or moves a value changes the Match signature: a positional call site compiled against the old shape either stops compiling or, if the assembly is not rebuilt, throws MissingMethodException at the first call, and a reordered value can rebind a positional argument to a different member without any diagnostic. Treat an added or moved enum value as a breaking change of that enum. Code that must survive regeneration untouched compares instead of matching: received == VerificationRefreshStatus.VerificationRefreshStatusUserPresenceRequired or received.Is(rawValue) against a raw wire value; neither reopens construction.

A value the SDK does not declare still round-trips: IsKnownValue() tells you whether it is one of the generated members, and sending the instance back echoes the server's own casing. You cannot construct an undeclared value yourself — there is no public factory — so a typo cannot compile; resolve a raw value with VerificationRefreshStatus.TryGetKnownValue("VERIFICATION_REFRESH_STATUS_USER_PRESENCE_REQUIRED", out var known).

A spec value whose name would collide with the enum's own name, with a member every enum inherits or generates (such as Value, Match or IsKnownValue), or with a member of object takes a Member suffix — a value value becomes ValueMember — and the other members keep their plain names.

SDK map

This SDK ships a generated SDK map — sdk-map.md plus the map/ pages — a deterministic, lookup-oriented table of contents of the SDK's C# surface, generated by APIMatic alongside this SDK.

Read it before scanning the source. Whether you are an AI coding assistant or searching by hand, the map answers "what is the exact …" by lookup for every call-level contract, and for anything it does not carry it names the one file that does — so you never have to search the source tree:

• sdk-map.md — the index: client construction, servers/auth, the options/retry reference, the SDK-wide defaults the operation rows rely on, and link tables into map/.
• map/operations/ — one page per controller: the exact C# signature, the return type, the error type with its typed TryGet… accessors, and pagination — plus, per operation, a Type sources table naming the file that declares every type that operation mentions.

Model shapes — record fields with their JSON wire names, enum member names and wire values, OneOf/AnyOf union variants — are not duplicated in the map. Take the path from the operation's Type sources table and read the declaring file; it is the single source of truth and cannot go stale against the code.

Each operation row states what is specific to that operation. The SDK-wide defaults are stated once in sdk-map.md — throw-only (no Result-style no-throw variants), no pagination, the four fixed RawError accessors, the Default server group — and a row appears only where its operation departs from one. A row silent on pagination is telling you that operation has none.

The HTTP verb and route, and the endpoint's behavioural prose, live on the operation itself, in the source file named at the top of its operations page. Read them there when something needs them — wiring a mock, reading a provider log, or settling a rule about what you must pass.

Workflow: look the fact up in the map → where the map leaves something ambiguous, open the one source file the row names → the compiler is the backstop (a name that isn't in the map won't build). Don't scan or grep the tree to find things — the map is the locator.

Which one to reach for

The map and the API Reference answer different questions, and the map is generated from this SDK's source so it stays in lockstep with the code it describes.

Error Handling

Operations throw when the server answers with an error status. TError is the operation's error type from the spec — RawError (the status code plus the raw body) when the spec declares none.

using ThePlaidApi.Core.Exceptions;     // the exception family
using ThePlaidApi.Requests.Accounts;   // request records such as AccountsBalanceGetOperationRequest
using ThePlaidApi.Models;              // models such as AccountsBalanceGetRequest

try
{
    var response = await client.Accounts.AccountsBalanceGet(new AccountsBalanceGetOperationRequest
    {
        Body = new AccountsBalanceGetRequest
        {
            AccessToken = "string",
            Secret = "string",
            ClientId = "string",
            Options = new AccountsBalanceGetRequestOptions { AccountIds = ["string"] },
        },
    });
}
catch (ApiException<RawError> ex)
{
    // "POST <server>/accounts/balance/get returned 400 (BadRequest)."
    Console.Error.WriteLine(ex.Message);
    Console.Error.WriteLine(ex.Error.ReadAsString());
}

Everything the SDK raises for a call derives from SdkException, which carries the failed call's Method and RequestUri. Every message starts with that call, and the underlying cause is always InnerException.

Catch from specific to general: ApiException means the server answered, SdkConnectionException means it did not, and SdkException is everything the SDK raises. Your own cancellation surfaces as the usual OperationCanceledException, never wrapped.

Best Practices

License

This SDK is distributed under the MIT License.

Support

Refer to the API reference for detailed information on available operations with code samples.