bank-131 / php-sdk
Bank131 PHP SDK
0.14.1
2022-06-30 14:32 UTC
Requires
- php: ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- ext-openssl: *
- guzzlehttp/guzzle: ~6.0
- psr/http-message: ^1.0
- psr/log: ^1.1
Requires (Dev)
- phpunit/phpunit: >=8.0
- vimeo/psalm: ^3.11
README
Библиотека для работы с API Bank131 в приложениях написанных на языке PHP.
Требования
- PHP 7.3 или выше
Установка
Рекомендуемый способ установки Bank 131 SDK - установка с помощью пакетного менеджера Composer.
Для включения данной библиотеки в ваш проект необходимо выполнить следующие команды в консоли:
cd /path/to/your/project
composer require 131/php-sdk
Документация
Более подробные примеры в документации API Банк 131
Быстрый старт
Инициализация клиента:
use Bank131\SDK\Client; use Bank131\SDK\Config; $config = new Config( 'https://demo.bank131.ru', 'test_project', file_get_contents('/path/to/your/private_key.pem'), file_get_contents('/path/to/bank131/public_key.pem') ); $client = new Client($config);
Выпуск публичного токена для создания виджета:
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory; $request = RequestBuilderFactory::create() ->issuePublicTokenBuilder() ->setTokenizeWidget() // публичный токен с доступом к виджету токенизации ->setSelfEmployedWidget('111111111111') // публичный токен с доступом к виджету для работы с самозанятыми ->setAcquiringWidget('session_id') // публичный токен с доступом к виджету эквайринга ->build(); $response = $this->client->widget()->issuePublicToken($request);
Создание и старт эквайринг сессии:
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory; use Bank131\SDK\Client; use Bank131\SDK\DTO\Customer; use Bank131\SDK\DTO\Card\BankCard; $request = RequestBuilderFactory::create() ->createPaymentSession() ->build(); /** @var Client $client */ $createSessionResponse = $client->session()->create($request); $request = RequestBuilderFactory::create() ->startPaymentSession($createSessionResponse->getSession()->getId()) ->setCard(new BankCard('4242424242424242', '12', '22', '123', 'CARDHOLDER NAME')) ->setAmount(10000, 'rub') ->setCustomer(new Customer('reference')) ->setMetadata('your metadata here') ->build(); $sessionStartResponse = $this->client->session()->startPayment($request);
Создание и старт сессии для осуществления выплаты:
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory; use Bank131\SDK\DTO\Card\EncryptedCard; use Bank131\SDK\DTO\Customer; use Bank131\SDK\DTO\Participant; use Bank131\SDK\Client; $request = RequestBuilderFactory::create() ->createPayoutSession() ->build(); /** @var Client $client */ $createSessionResponse = $client->session()->create($request); $recipient = new Participant(); $recipient->setFullName('John Doe'); $request = RequestBuilderFactory::create() ->startPayoutSession($createSessionResponse->getSession()->getId()) ->setCard(new EncryptedCard('number_hash_here')) ->setRecipient($recipient) ->setAmount(10000, 'rub') ->setCustomer(new Customer('reference')) ->setMetadata('your metadata here') ->build(); $sessionStartResponse = $this->client->session()->startPayout($request);
Запрос статуса сессии:
use Bank131\SDK\Client; /** @var Client $client */ $response = $this->client->session()->status('session_id');
Возврат:
use Bank131\SDK\API\Request\Builder\RequestBuilderFactory; $request = RequestBuilderFactory::create() ->refundSession('session_id') ->setAmount(1000, 'rub') ->setMetadata('your metadata here') ->build(); $response = $this->client->session()->refund($request);
Запрос баланса кошелька:
use Bank131\SDK\Client; /** @var Client $client */ $response = $client->wallet()->balance();
Обработка веб-хуков:
use Bank131\SDK\Client; use Bank131\SDK\Services\WebHook\Hook\WebHookTypeEnum; /** @var Client $client */ $hook = $client->handleWebHook('sign from headers', 'request body'); switch ($hook->getType()) { case WebHookTypeEnum::READY_TO_CONFIRM: $client->session()->confirm($hook->getSession()->getId()); break; case WebHookTypeEnum::READY_TO_CAPTURE: $client->session()->capture($hook->getSession()->getId()); break; case WebHookTypeEnum::ACTION_REQUIRED: //do some logic break; case WebHookTypeEnum::PAYMENT_FINISHED: //do some logic break; case WebHookTypeEnum::PAYMENT_REFUNDED: //do some logic break; }