Getting Started with The Plaid API

Introduction

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

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

| Parameter | Type | Description | | --- | --- | --- | | environment | Environment | The API environment. Default: Environment.Production | | timeout | number | Timeout for API calls.Default: 0 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | logging | PartialLoggingOptions | Logging Configuration to enable logging | | plaidClientIdCredentials | PlaidClientIdCredentials | The credential object for plaidClientId | | plaidSecretCredentials | PlaidSecretCredentials | The credential object for plaidSecret | | plaidVersionCredentials | PlaidVersionCredentials | The credential object for plaidVersion |

The API client can be initialized as follows:

Code-Based Client Initialization

import { Client, Environment, LogLevel } from 'apimatic-plaid-sdk';

const client = new Client({
  plaidClientIdCredentials: {
    'PLAID-CLIENT-ID': 'PLAID-CLIENT-ID'
  },
  plaidSecretCredentials: {
    'PLAID-SECRET': 'PLAID-SECRET'
  },
  plaidVersionCredentials: {
    'Plaid-Version': 'Plaid-Version'
  },
  timeout: 0,
  environment: Environment.Production,
  logging: {
    logLevel: LogLevel.Info,
    logRequest: {
      logBody: true
    },
    logResponse: {
      logHeaders: true
    }
  },
});

Configuration-Based Client Initialization

import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'apimatic-plaid-sdk';

// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');

// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');

// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);

See the Configuration-Based Client Initialization section for details.

Environment-Based Client Initialization

import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'apimatic-plaid-sdk';

// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');

if (fs.existsSync(absolutePath)) {
  // Load environment variables from .env file
  dotenv.config({ path: absolutePath, override: true });
}

// Initialize client using environment variables
const client = Client.fromEnvironment(process.env);

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

| Name | Description | | --- | --- | | Production | Default Production | | Environment2 | Development | | Environment3 | Sandbox |

Authorization

This API uses the following authentication schemes.

• PLAID-CLIENT-ID (Custom Header Signature)
• PLAID-SECRET (Custom Header Signature)
• Plaid-Version (Custom Header Signature)

List of APIs

• Item
• Asset Report
• Processor
• Payment Initiation
• Sandbox
• Investments
• Institutions
• Application
• Accounts
• Identity
• Liabilities
• Auth
• Transactions
• Categories
• Webhook Verification Key
• Deposit Switch
• Link
• Transfer
• Bank Transfer
• Employers
• Income
• Signal

SDK Infrastructure

Configuration

• HttpClientOptions
• RetryConfiguration
• ProxySettings
• Configuration-Based Client Initialization
• Environment-Based Client Initialization
• PartialLoggingOptions
• PartialRequestLoggingOptions
• PartialResponseLoggingOptions
• LoggerInterface

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError