README

Introduction

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

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "sdksio/plaid-apimatic-sdk:1.0.0"

Or add it to the composer.json file manually as given below:

"require": {
    "sdksio/plaid-apimatic-sdk": "1.0.0"
}

You can also view the package at: https://packagist.org/packages/sdksio/plaid-apimatic-sdk#1.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

use ThePlaidApiLib\Logging\LoggingConfigurationBuilder;
use ThePlaidApiLib\Logging\RequestLoggingConfigurationBuilder;
use ThePlaidApiLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use ThePlaidApiLib\Environment;
use ThePlaidApiLib\Authentication\ClientIdCredentialsBuilder;
use ThePlaidApiLib\Authentication\SecretCredentialsBuilder;
use ThePlaidApiLib\Authentication\PlaidVersionCredentialsBuilder;
use ThePlaidApiLib\ThePlaidApiClientBuilder;

$client = ThePlaidApiClientBuilder::init()
    ->clientIdCredentials(
        ClientIdCredentialsBuilder::init(
            'PLAID-CLIENT-ID'
        )
    )
    ->secretCredentials(
        SecretCredentialsBuilder::init(
            'PLAID-SECRET'
        )
    )
    ->plaidVersionCredentials(
        PlaidVersionCredentialsBuilder::init(
            'Plaid-Version'
        )
    )
    ->environment(Environment::SANDBOX)
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

Environments

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

Fields

Authorization

This API uses the following authentication schemes.

• clientId (Custom Header Signature)
• secret (Custom Header Signature)
• plaidVersion (Custom Header Signature)

List of APIs

• Plaid

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest

Utilities

• ApiResponse