通过 
搜索
搜索kvash / php-tochka-sdk
PHP的Tochka银行API客户端
0.2
2024-04-12 10:48 UTC
Requires
- php: ^8.2
- ext-curl: *
- ext-json: *
Requires (Dev)
- mockery/mockery: ^1.0
- phpunit/phpunit: ^4.8.35 || ^5.7
README
PHP的Tochka银行API客户端
安装
PHP的Tochka API客户端可以通过Composer安装。运行以下命令：
composer require lee-to/php-tochka-api-sdk
使用
导入。
use TochkaApi\TochkaApi; use TochkaApi\HttpAdapters\CurlHttpClient;
初始化。
$tochkaApi = new TochkaApi("client_id", "client_secret", new CurlHttpClient); //Для установки JWT токена //$tochkaApi->setAccessToken("");
OAuth2认证。
// Урл для авторизации, после подтверждения вернет $_GET["code"] на redirect_uri $tochkaApi->getAuthorizeUrl(); //Вернет объект AccessToken для $tochkaApi->setAccessToken(""); $tochkaApi->token($_GET["code"]);
账户和组织
组织列表
$tochkaApi->organization()->list()
账户列表
$tochkaApi->account()->list()
账单
创建账单
参数
- account_code — 账户号码。
- bank_code — 银行代码（9位数）。
- date_end — 账单结束日期，格式为YYYY-MM-DD。
- date_start — 账单开始日期，格式为YYYY-MM-DD。
$tochkaApi->statement()->create(array $parameters);
请求状态
参数
- request_id — 请求ID，在“创建请求”步骤中获取。
$tochkaApi->statement()->status($request_id);
请求结果
参数
- request_id — 请求ID，在“创建请求”步骤中获取。
$tochkaApi->statement()->result($request_id);
付款
创建付款
参数
- account_code (string) — 发送者账户（20位数字）
- bank_code (string) — 发送者银行代码（9位数字）
- counterparty_account_number (string) — 收款人账户（20位数字）
- counterparty_bank_bic (string) — 收款人银行代码（9位数字）
- counterparty_inn (string) — 收款人INN（10位或12位数字）
- counterparty_kpp (string) — 收款人KPP（9位数字）
- counterparty_name (string) — 付款收款人（最多160个字符，西里尔字母，数字，符号）
- payment_amount (string) — 付款金额（最多18位数字）
- payment_date (string) — 付款日期（根据俄罗斯联邦银行2012年6月19日第383-P号令修订，格式为DD.MM.YYYY）
- payment_number (string) — 付款号码（6位数字）
- payment_priority (string) — 付款优先级（1位数字）
- payment_purpose (string) — 付款目的（最多210个字符）
- payment_purpose_code (string) — 可选字段。收入类型代码（“1”，“2”，“3”或空）。更多信息：联邦法律229，俄罗斯联邦银行第5286号指令，联邦法律12。
- supplier_bill_id (string) — УИН代码（1，20，25个西里尔字母，数字）
- tax_info_document_date (string) — 预算文件日期（1至10位数字）
- tax_info_document_number (string) — 文件编号（最多15个字符）
- tax_info_kbk (string) — КБК（1至20位数字）
- tax_info_okato (string) — ОКАТО/ОКТМО代码（1至8位数字）
- tax_info_period (string) — 税收期间/海关机构代码（1至8，10个西里尔字母，数字，符号）
- tax_info_reason_code (string) — 付款依据（2个西里尔字母）
- tax_info_status (string) — 付款人状态（2位数字）
$tochkaApi->payment()->create(array $parameters);
付款状态
参数
- request_id — 请求ID，在“创建请求”步骤中获取。
$tochkaApi->payment()->status($request_id);
工资项目
请求员工列表
参数
- customer_code — 组织ID
$tochkaApi->salary()->employeeList($customer_code);
获取员工列表
$tochkaApi->salary()->result($request_id);
添加员工
参数
customer_code (string) 客户标识符。
employees (array) 员工列表。
- account_code (string) 员工银行账户号码。
- bank_code (string) 员工银行代码。
- birthdate (string) 员工出生日期。
- first_name (string) 员工姓名。
- last_name (string) 员工姓氏。
- middle_name (string) 员工名字。
$tochkaApi->salary()->employeeAdd($customer_code, array $employees);
创建付款清单请求
参数
customer (object) 付款人。
- customer_code (string) 客户标识符。
- account_code (string) 付款人银行账户号码。
- bank_code (string) 付款人银行代码。
- |revenue_type| 可选字段。个人收入类型代码（“1”、“2”、“3”或空）。详细信息：联邦法律229号，俄罗斯银行指令N 5286，联邦法律12号。
payments (数组) 支付款列表。
- account_code (字符串) 收款人银行账户号码。
- amount (字符串) 支付款金额。
- bank_code (字符串) 收款人银行BIC。
- birthdate (string) 员工出生日期。
- first_name (string) 员工姓名。
- last_name (string) 员工姓氏。
- middle_name (string) 员工名字。
- |recoupment| 可选字段。根据|revenue_type|追回的金额。
payment_period_start_date (字符串) 计算期开始日期。
payment_period_end_date (字符串) 计算期结束日期。
purpose_id (字符串) 目的标识符。
$tochkaApi->salary()->payrollCreate(array $customer, array $payments, $payment_period_start_date, $payment_period_end_date, $purpose_id);
查询可能的目的
$tochkaApi->salary()->purposes();
测试
- Composer 是运行测试的先决条件。全局安装composer，然后运行
composer install安装所需文件。 - 获取个人JWT令牌，然后从
tests/TochkaTestCredentials.php.dist创建tests/TochkaTestCredentials.php，并编辑它以添加您的凭据。 - 可以通过从根目录运行此命令来执行测试
$ ./vendor/bin/phpunit
贡献
有关详细信息，请参阅CONTRIBUTING。
致谢
许可
MIT许可（MIT）。有关更多信息，请参阅许可文件。
安全
如果您发现了一个安全问题，请直接联系维护者leetodev@ya.ru。