lee-to/php-tochka-api-sdk

PHP 版本的 Tochka 银行 API 客户端

维护者

详细信息

github.com/lee-to/php-tochka-api-sdk

主页

源代码

问题

安装: 189

依赖: 0

建议者: 0

安全: 0

星标: 4

关注者: 2

分支: 3

开放问题: 1

v0.9 2020-08-18 15:27 UTC

Requires

Requires (Dev)

MIT 9fb6b82816bee7f66a7a8645949a07367291b610

apiTochka

This package is auto-updated.

Last update: 2024-08-29 05:31:05 UTC

README

API 2 版本的 SDK

PHP 版本的 Tochka API 客户端

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 — 银行代码。
  • 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) — 收款方税号 (10, 12 位数字)
  • counterparty_kpp (string) — 收款方税务登记证号码 (9, 数字)
  • counterparty_name (string) — 支付收款方 (最多 160 个字符，俄语，数字，符号)
  • payment_amount (string) — 支付款项 (最多 18 位数字)
  • payment_date (string) — 支付日期 (根据俄罗斯联邦中央银行 2012 年 6 月 19 日第 383-П号（2018 年 10 月 11 日修订）的规定，格式为 DD.MM.YYYY)
  • payment_number (string) — 支付号码 (6, 数字)
  • payment_priority (string) — 支付优先级 (1, 数字)
  • payment_purpose (string) — 支付目的 (最多 210 个字符)
  • payment_purpose_code (string) — 可选字段。收入类型代码（“1”，“2”，“3”或空）。更多信息：联邦法律 229，俄罗斯联邦中央银行 N 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 (字符串) 付款银行代码。
  • |revenue_type| 可选字段。个人收入类型代码（“1”、“2”、“3”或空）。详细信息：联邦法律第229号，俄罗斯联邦中央银行令第5286号，联邦法律第12号。

payments (数组) 支付款项列表。

  • account_code (字符串) 收款人银行账户号码。
  • amount (字符串) 支付款项金额。
  • bank_code (字符串) 收款银行代码。
  • 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();

测试

  1. Composer 是运行测试的先决条件。全局安装 composer，然后运行 composer install 来安装所需文件。
  2. 获取个人 JWT 令牌，然后从 tests/TochkaTestCredentials.php.dist 创建 tests/TochkaTestCredentials.php 并编辑它以添加您的凭据。
  3. 可以通过在根目录中运行此命令来执行测试
$ ./vendor/bin/phpunit

贡献

有关详细信息，请参阅CONTRIBUTING。

鸣谢

许可协议

MIT 许可协议（MIT）。有关更多信息，请参阅许可文件。

安全

如果您发现了一个安全问题，请直接通过leetodev@ya.ru联系维护者。