lee-to/php-tochka-api-sdk

Tochka bank API client for PHP

Maintainers

Details

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

Homepage

Source

Issues

Installs: 190

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 2

Forks: 3

Open Issues: 1

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

Requires

Requires (Dev)

MIT 9fb6b82816bee7f66a7a8645949a07367291b610

apiTochka

This package is auto-updated.

Last update: 2024-10-29 06:05:54 UTC

README

SDK для версии API 2

Tochka API client for PHP

Tochka bank API client for PHP

Installation

Tochka API client for PHP can be installed with Composer. Run this command:

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 — дата окончания срока выписки, формат даты ГГГГ-ММ-ДД.
  • date_start — дата начала срока выписки, формат даты ГГГГ-ММ-ДД.
$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) — дата платежа (В соответствии с Положением Банка России от 19.06.2012 № 383-П(ред. от 11.10.2018), в формате ДД.ММ.ГГГГ)
  • 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 (string) БИК банка плательщика.
  • |revenue_type| опциональное поле. Код вида дохода физ. лица («1», «2», «3» или пусто). Подробнее: ФЗ 229, Указание Банка России N 5286, ФЗ 12.

payments (array) Список платежей.

  • account_code (string) Номер банковского счёта получателя.
  • amount (string) Сумма платежа.
  • bank_code (string) БИК банка получателя.
  • birthdate (string) Дата рождения сотрудника.
  • first_name (string) Имя сотрудника.
  • last_name (string) Фамилия сотрудника.
  • middle_name (string) Отчество сотрудника.
  • |recoupment| опциональное поле. Взысканная сумма по |revenue_type|.

payment_period_start_date (string) Дата начала расчётного периода.

payment_period_end_date (string) Дата конца расчётного периода.

purpose_id (string) Идентификатор назначения.

$tochkaApi->salary()->payrollCreate(array $customer, array $payments, $payment_period_start_date, $payment_period_end_date, $purpose_id);

Запрос возможных назначений

$tochkaApi->salary()->purposes();

Tests

  1. Composer is a prerequisite for running the tests. Install composer globally, then run composer install to install required files.
  2. Get personal JWT token, then create tests/TochkaTestCredentials.php from tests/TochkaTestCredentials.php.dist and edit it to add your credentials.
  3. The tests can be executed by running this command from the root directory:
$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.

Security

If you have found a security issue, please contact the maintainers directly at leetodev@ya.ru.