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:

Parameter	Type	Description
environment	`Environment`	The API environment. Default: `Environment.SANDBOX`
timeout	`int`	Timeout for API calls in seconds. Default: `30`
enableRetries	`bool`	Whether to enable retries and backoff feature. Default: `false`
numberOfRetries	`int`	The number of retries to make. Default: `0`
retryInterval	`float`	The retry time interval between the endpoint calls. Default: `1`
backOffFactor	`float`	Exponential backoff factor to increase interval between retries. Default: `2`
maximumRetryWaitTime	`int`	The maximum wait time in seconds for overall retrying requests. Default: `0`
retryOnTimeout	`bool`	Whether to retry on request timeout. Default: `true`
httpStatusCodesToRetry	`array`	Http status codes to retry against. Default: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524`
httpMethodsToRetry	`array`	Http methods to retry against. Default: `'GET', 'PUT'`
loggingConfiguration	`LoggingConfigurationBuilder`	Represents the logging configurations for API calls
proxyConfiguration	`ProxyConfigurationBuilder`	Represents the proxy configurations for API calls
clientIdCredentials	`ClientIdCredentials`	The Credentials Setter for Custom Header Signature
secretCredentials	`SecretCredentials`	The Credentials Setter for Custom Header Signature
plaidVersionCredentials	`PlaidVersionCredentials`	The Credentials Setter for Custom Header Signature

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

Name	Description
SANDBOX	Default
PRODUCTION	-

sdksio / plaid-apimatic-sdk

Maintainers

Package info

Statistics

Security

README

Introduction

Install the Package

Initialize the API Client

Environments

Fields

Authorization

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities