elminson/plaid-sdk-php

PHP implementation of Plaid's API as an SDK.

v1.0.1 2024-06-08 02:51 UTC

Requires

• php: >=7.3|>=8.3
• ext-curl: *
• ext-json: *
• nimbly/shuttle: ^0.4

Requires (Dev)

• php-coveralls/php-coveralls: ^2.1
• phpunit/phpunit: ^9.0
• symfony/var-dumper: ^4.2
• vimeo/psalm: ^4.0

MIT

• Brent Scheffler

• php
• sdk
• plaid

README

Plaid PHP SDK supporting:

• Link tokens
• Auth
• Items
• Accounts
• Institutions
• Webhooks
• Identity
• Income
• Assets
• Balance
• Liabilities
• Investments
• Payment Initiation (UK only)
• Processors (including Stripe & Dwolla)
• Bank Transfers (US only)
• Sandbox

Official Plaid API docs

For full description of request and response payloads and properties, please see the official Plaid API docs.

Requirements

• PHP 7.3+ | PHP 8.0+
• ext-curl
• ext-json

Installation

composer require tomorrow-ideas/plaid-sdk-php

Configuration

Instantiate the Plaid client class with your credentials.

$client = new \TomorrowIdeas\Plaid\Plaid("your-client-id", "your-secret", "environment");

Environments

The Plaid client by default uses the production Plaid API hostname for all API calls. You can change the environment by using the setEnvironment method.

Possible environments:

• production
• development
• sandbox

Options

Many methods allow the passing of options to the Plaid endpoint. These options should be an associative array of key/value pairs. The exact options supported are dependent on the endpoint being called. Please refer to the official Plaid documentation for more information.

$options = [
	"foo" => "bar",
	"baz" => "bat"
];

Example

use TomorrowIdeas\Plaid\Plaid;

require __DIR__ . "/vendor/autoload.php";

$plaid = new Plaid(
	\getenv("PLAID_CLIENT_ID"),
	\getenv("PLAID_CLIENT_SECRET"),
	\getenv("PLAID_ENVIRONMENT")
);

$item = $plaid->items->get("itm_1234");

Resources

For a full description of the response payload, please see the official Plaid API docs.

Accounts

Resource: accounts

Reference: https://plaid.com/docs/#accounts

Methods:

• list(string $access_token, array $options = []): object
• getBalance(string $access_token, array $options = []): object
• getIdentity(string $access_token): object

Example:

$accounts = $plaid->accounts->list($access_token);

Auth

Resource: auth

Reference: https://plaid.com/docs/#auth

Methods:

• get(string $access_token, array $options = []): object

Example:

$auth = $plaid->auth->get($access_token);

Bank Transfers (U.S. only)

Resource: bank_transfers

Reference: https://plaid.com/docs/bank-transfers/

Methods:

create(
	string $access_token,
	string $idempotency_key,
	string $type,
	string $account_id,
	string $network,
	string $amount,
	string $currency_code,
	AccountHolder $account_holder,
	string $description,
	string $ach_class = null,
	string $custom_tag = null,
	array $metadata = [],
	string $origination_account_id = null): object

• cancel(string $bank_transfer_id): object
• get(string $bank_transfer_id): object
• list( ?DateTime $start_date = null, ?DateTime $end_date = null, ?int $count = null, ?int $offset = null, ?string $direction = null, ?string $origination_account_id = null): object
• getEventList( ?DateTime $start_date = null, ?DateTime $end_date = null, ?string $bank_transfer_id = null, ?string $account_id = null, ?string $bank_transfer_type = null, array $event_type = [], ?int $count = null, ?int $offset = null, ?string $direction = null, ?string $origination_account_id = null): object
• syncEvents(string $after_id, ?int $count = null): object
• migrateAccount(string $account_number, string $routing_number, string $account_type): object
• getOriginationAccountBalance(string $origination_account_id = null): object

Example:

$transfers = $plaid->bank_transfers->list();

Categories

Resource: categories

Reference: https://plaid.com/docs/api/products/#categoriesget

Methods:

• list(): object

Example:

$categories = $plaid->categories->list();

Institutions

Resource: institutions

Reference: https://plaid.com/docs/api/institutions/

Methods:

• get(string $institution_id, array $country_codes, array $options = []): object
• list(int $count, int $offset, array $country_codes, array $options = []): object
• find(string $query, array $country_codes, array $products = [], array $options = []): object

Example:

$institutions = $plaid->institutions->list(20, 0);

Investments

Resource: investments

Reference: https://plaid.com/docs/api/products/#investments

Methods:

• listHoldings(string $access_token, array $options = []): object
• listTransactions(string $access_token, DateTime $start_date, DateTime $end_date, array $options = []): object

Example:

$holdings = $plaid->investments->listHoldings($access_token);

Tokens

Resource: tokens

Reference: https://plaid.com/docs/api/tokens/

Methods:

create(string $client_name,
	string $language,
	array $country_codes,
	User $user,
	array $products = [],
	?string $webhook = null,
	?string $link_customization_name = null,
	?AccountFilters $account_filters = null,
	?string $access_token = null,
	?string $redirect_url = null,
	?string $android_package_name = null,
	?string $payment_id = null): object

get(string $link_token): object

Example:

$token = $plaid->tokens->create($client_name, $language, ["US","CA"], $user_id);

Liabilities

Resource: liabilities

Reference: https://plaid.com/docs/api/products/#liabilities

Methods:

• list(string $access_token, array $options = []): object

Example:

$liabilities = $plaid->liabilities->list($access_token);

Items

Resource: items

Reference: https://plaid.com/docs/api/items/

Methods:

• get(string $access_token): object
• remove(string $access_token): object
• getIncome(string $access_token): object
• createPublicToken(string $access_token): object
• exchangeToken(string $public_token): object
• rotateAccessToken(string $access_token): object

$item = $plaid->items->get($access_token);

Webhooks

Resource: webhooks

Reference: https://plaid.com/docs/api/webhooks/

Methods:

• getVerificationKey(string $key_id): object
• update(string $access_token, string $webhook): object

Example:

$verification_key = $plaid->webhooks->getVerificationKey($key_id);

Transactions

Resource: transactions

Reference: https://plaid.com/docs/api/products/#transactions

Methods:

• list(string $access_token, DateTime $start_date, DateTime $end_date, array $options = []): object
• refresh(string $access_token): object
• sync(string $access_token, ?string $cursor = null, ?int $count = null, array $options = []): object
• recurring(string $access_token, array $account_ids, array $options = []): object

Example:

$transactions = $plaid->transactions->list($access_token, $start_date, $end_date);

Reports

Resource: reports

Reference: https://plaid.com/docs/assets/

Methods:

• createAssetReport(array $access_tokens, int $days_requested, array $options = []): object
• refreshAssetReport(string $asset_report_token, int $days_requested, array $options = []): object
• filterAssetReport(string $asset_report_token, array $exclude_accounts): object
• getAssetReport(string $asset_report_token, bool $include_insights = false): object
• getAssetReportPdf(string $asset_report_token): ResponseInterface Note: Because this endpoint returns PDF content in the repsponse body, this method returns an instance of a PSR-7 ResponseInterface. You may leverage the Response object to stream the PDF back to the requesting client and access response headers
• removeAssetReport(string $asset_report_token): object
• createAssetReportAuditCopy(string $asset_report_token, string $auditor_id): object
• removeAssetReportAuditCopy(string $audit_copy_token): object

Payment Initiation (UK only)

Resource: payments

Reference: https://plaid.com/docs/#payment-initiation

Methods:

• createRecipient(string $name, string $iban, RecipientAddress $address): object
• getRecipient(string $recipient_id): object
• listRecipients(): object
• create(string $recipient_id, string $reference, float $amount, string $currency, PaymentSchedule $payment_schedule = null): object
• createToken(string $payment_id): object
• get(string $payment_id): object
• list(array $options = []): object

Example:

$plaid->payments->createRecipient($name, $iban, $address);

Processors

Resource: processors

Reference: https://plaid.com/docs/api/processors

Methods:

• createToken(string $access_token, string $account_id, string $processor): object
• getAuth(string $processor_token): object
• getBalance(string $processor_token): object
• getIdentity(string $processor_token): object
• createStripeToken(string $access_token, string $account_id): object [?]
• createDwollaToken(string $access_token, string $account_id): object [?]

Sandbox

Resource: sandbox

Reference: https://plaid.com/docs/api/sandbox/

Methods:

• createPublicToken(string $institution_id, array $initial_products, array $options = []): object
• resetLogin(string $access_token): object
• setVerificationStatus(string $access_token, string $account_id, string $verification_status): object
• fireWebhook(string $access_token, string $webhook_code = "DEFAULT_UPDATE"): object
• simulateBankTransfer(string $bank_transfer_id, string $event_type, ?string $ach_return_code = null, ?string $failure_description = null): object

Example:

$response = $plaid->sandbox->fireWebhook($access_token);

Entities

User

The TomorrowIdeas\Plaid\Entities\User entity is used to represent your end user when creating a new link token.

Example:

$token_user = new User(
	string $id,
	?string $name = null,
	?string $phone_number = null,
	?string $phone_number_verified_time = null,
	?string $email_address = null,
	?string $ssn = null,
	?string $date_of_birth = null
)

RecipientAddress

The TomorrowIdeas\Plaid\Entities\RecipientAddress entity is used to represent an address object for the recipient of a payment request.

Example:

$address = new TomorrowIdeas\Plaid\Entities\RecipientAddress("123 Elm St.", "Apt 1", "Anytown", "ABC 123", "GB");

PaymentSchedule

Example:

The TomorrowIdeas\Plaid\Entities\PaymnentSchedule entity is used when creating a new payment that will be a recurring charge. See createPayment method for more information.

$payment_schedule = new TomorrowIdeas\Plaid\Entities\PaymnentSchedule(
    PaymentSchedule::INTERVAL_MONTHLY,
    15,
    new DateTime("2020-10-01")
);

Errors

All unsuccessfull (non 2xx) responses will throw a PlaidRequestException. The full response object is available via the getResponse() method.