README

这是一个用于 GoCardless 银行账户数据的非官方 PHP 客户端库的分支。此分支需要至少 PHP 8.2。

有关端点和参数的完整列表，请参阅 文档。

在开始使用 API 之前，您需要创建一个新的密钥并从 Nordigen 的 开放银行门户 获取您的 SECRET_ID 和 SECRET_KEY。

需求

• PHP >= 8.2

安装

使用 Composer 安装库

composer require helixdigital-io/nordigen-php

示例应用

Laravel 示例应用位于 example 目录

快速入门

要使用库，请使用 Composer 的 自动加载

require_once('vendor/autoload.php');

// Get secretId and secretKey from bankaccoutndata.gocardless.com portal and pass them to NordigenClient
$secretId  = "YOUR_SECRET_ID";
$secretKey = "YOUR_SECRET_KEY";

$client = new \Nordigen\NordigenPHP\API\NordigenClient($secretId, $secretKey);

// Generate new access token. Token is valid for 24 hours
// Token is automatically injected into every response
$token = $client->createAccessToken();

// Get access token
$accessToken = $client->getAccessToken();
// Get refresh token
$refreshToken = $client->getRefreshToken();

// Exchange refresh token for new access token
$newToken = $client->refreshAccessToken($refreshToken);

// Get list of institutions by country. Country should be in ISO 3166 standard.
$institutions = $client->institution->getInstitutionsByCountry("LV");

// Institution id can be gathered from getInstitutions response.
// Example Revolut ID
$institutionId = "REVOLUT_REVOGB21";
$redirectUri = "https://nordigen.com";

// Initialize new bank connection session
$session = $client->initSession($institutionId, $redirectUri);

// Get link to authorize in the bank
// Authorize with your bank via this link, to gain access to account data
$link = $session["link"];
// requisition id is needed to get accountId in the next step
$requisitionId = $session["requisition_id"];

在与银行成功授权后，您可以获取您的数据（详情，余额，交易）

获取账户元数据、余额、详情和交易

// Get account id after completed authorization with a bank
$requisitionData = $client->requisition->getRequisition($requisitionId);
// Get account id from the array of accounts
$accountId = $requisitionData["accounts"][0];

// Instantiate account object
$account = $client->account($accountId);

// Fetch account metadata
$metadata = $account->getAccountMetaData();
// Fetch account balances
$balances = $account->getAccountBalances();
// Fetch account details
$details = $account->getAccountDetails();
// Fetch account transactions
$transactions = $account->getAccountTransactions();

// Optional. You can filter transactions by specific date range
$transactions = $account->getAccountTransactions("2021-12-01", "2022-01-30");

// Get premium transactions
// Optional parameters country, dateFrom, dateTo
$premiumTransactions = $account->getPremiumAccountTransactions();

要使用 Premium 端点，请联系我们的 bank-account-data-support@gocardless.com

测试

./vendor/bin/phpunit

支持

如有任何疑问，请联系 bank-account-data-support@gocardless.com 的支持或在该存储库中创建一个问题。