README

plaid.com API 的 PHP 客户端

这是 Plaid API 的官方 python 客户端库的 PHP 版本

安装

$ composer require dpods/plaid-api-php-client

文档

该模块目前只支持少数几个 Plaid API 端点。有关 Plaid.com API 的完整信息，请访问Plaid 文档。

示例

交换公共令牌以获取访问令牌

将来自 Plaid Link 的 public_token 交换为 Plaid 访问令牌

$clientId = '*****';
$secret = '*****';
$publicKey = '*****';
$publicToken = '<public_token from Plaid Link>';

// Available environments are 'sandbox', 'development', and 'production'
$client = new Client($clientId, $secret, $publicKey, 'sandbox');
$response = $client->item()->publicToken()->exchange($publicToken);
$accessToken = $response['access_token'];

检索交易

$response = $client->transactions()->get($accessToken, '2018-01-01', '2018-01-31');
$transactions = $response['transactions'];

资产报告

检索资产报告有多个步骤。

创建报告
筛选不想要的账户从报告中移除
检索报告（JSON 或 PDF 格式）
刷新已创建或筛选过的报告
删除报告

创建资产报告

// an array of previously generated access_tokens
$accessTokens = ['<access_token(s) returned from exchange token call(s)>'];
$daysRequested = 180;
// all of these are optional
$options = [
  'client_report_id' => '<user supplied id for reference',
  'webhook' => 'https://your-application.io/webhook',
  'user' => [
    'client_user_id' => '<user supplied id>',
    'first_name' => 'Testynthia',
    'middle_name' => 'T.',
    'last_name' => 'Tertestdez',
    'ssn' => '123-45-6789',
    'phone_number' => '555-555-1234',
    'email' => 'test@test.com'
  ]
];
$response = $this->client->assetReport()->create($accessTokens, $daysRequested, $options);

创建资产报告响应

{
  "asset_report_id": "<asset_report guid>",
  "asset_report_token": "<assets-sandbox-guid>",
  "request_id": "<request_id>"
}

筛选资产报告

$assetReportToken = '<returned in asset report creation call>';
$accountIdsToExclude = ['<credit_card_id>', '<401k_account_id>'];
$response = $this->client->assetReport()->filter($assetReportToken, $accountIdsToExclude);

筛选资产报告响应

{
  "asset_report_id": "<asset_report guid>",
  "asset_report_token": "<assets-sandbox-guid>",
  "request_id": "<request_id>"
}

检索资产报告

// retrieve the report in JSON format
$response = $this->client->assetReport()->get($accessReportToken);

// retrieve the report in PDF format
$response = $this->client->assetReport()->getPdf($accessReportToken);
file_put_contents('asset-report.pdf', $response);

检索资产报告响应

资产报告的 JSON 结果可以在 plaid 文档中查看。

/asset_report/pdf/get 端点返回二进制 PDF 数据，可以将其保存到本地文件。

刷新资产报告

// $daysRequested is optional and only needed if you want to override the value sent when report was created
// $options is optional, only required for overrides to previous values
$response = $this->client->assetReport()->refresh($assetReportToken, $daysRequested, $options);

刷新资产报告响应

{
  "asset_report_id": "<asset_report guid>",
  "asset_report_token": "<assets-sandbox-guid>",
  "request_id": "<request_id>"
}

删除资产报告

$response = $this->client->assetReport()->remove($assetReportToken);

删除资产报告响应

{
  "removed": true,
  "request_id": "<request_id>"
}

许可

MIT

dpods / plaid-api-php-client

维护者

详情