Saved searches
Use saved searches to filter your results more quickly
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
PHP SDK для единого платежного протокола эквайринга и QIWI Кошелька.
License
QIWI-API/bill-payments-php-sdk
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Sign In Required
Please sign in to use Codespaces.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
Git stats
Files
Failed to load latest commit information.
README.md
Universal payments API PHP SDK
PHP SDK модуль для внедрения единого платежного протокола эквайринга и QIWI Кошелька.
$ composer require qiwi/bill-payments-php-sdk
Пошаговое руководство по работе с SDK (для физических лиц): https://developer.qiwi.com/ru/p2p-sdk-guide/#integration-sdk
API P2P-счетов (для физических лиц): https://developer.qiwi.com/ru/p2p-payments
API QIWI Кассы (для юридических лиц): https://developer.qiwi.com/ru/bill-payments
Генерация авто-документации composer run docs .
Для использования SDK требуется SECRET_KEY , подробности в документации — для физ.лиц, для юр.лиц.
const SECRET_KEY = 'eyJ2ZXJzaW9uIjoicmVzdF92MyIsImRhdGEiOnsibWVyY2hhbnRfaWQiOjUyNjgxMiwiYXBpX3VzZXJfaWQiOjcxNjI2MTk3LCJzZWNyZXQiOiJmZjBiZmJiM2UxYzc0MjY3YjIyZDIzOGYzMDBkNDhlYjhiNTnONPININONPN090MTg5Z**********************'; $billPayments = new Qiwi\Api\BillPayments(SECRET_KEY); ?> Смена SECRET_KEY на новый:
const NEW_SECRET_KEY = 'kokoOKPzaW9uIjoicmVzdF92MyIsImRhdGEiOnsibWVyY2hhbnRfaWQiOjUyNjgxMiwiYXBpX3VzZXJfaWQiOjcxNjI2MTk3LCJzZWNyZXQiOiJmZjBiZmJiM2UxYzc0MjY3YjIyZDIzOGYzMDBkNDhlYjhiNTk5NmIbhchhbbHBHIBDBI**********************'; /** @var \Qiwi\Api\BillPayments $billPayments */ $billPayments->key = NEW_SECRET_KEY; ?> По умолчанию пользователю доступно несколько способов оплаты. В платежной форме параметры счета передаются в открытом виде в ссылке. Далее клиенту отображается форма с выбором способа оплаты. При использовании этого способа нельзя гарантировать, что все счета выставлены мерчантом, в отличие от выставления по API. Через API все параметры передаются в закрытом виде , так же в API поддерживаются операции выставления и отмены счетов, возврата средств по оплаченным счетам (только для юр. лиц), а также проверки статуса выполнения операций.
Простой способ для интеграции. При открытии формы клиенту автоматически выставляется счет. Параметры счета передаются в открытом виде в ссылке. Далее клиенту отображается платежная форма с выбором способа оплаты. При использовании этого способа нельзя гарантировать, что все счета выставлены мерчантом, в отличие от выставления по API.
Метод createPaymentForm создает платежную форму. В параметрах нужно указать: ключ идентификации провайдера publicKey , полученный в личном кабинете QIWI, идентификатор счета billId внутри вашей системы и сумму amount . В результате будет получена ссылка на форму оплаты, которую можно передать клиенту. Подробнее о доступных параметрах в документации — для физ. лиц, для юр. лиц.
$publicKey = '2tbp1WQvsgQeziGY9vTLe9vDZNg7tmCymb4Lh6STQokqKrpCC6qrUUKEDZAJ7mvFnzr1yTebUiQaBLDnebLMMxL8nc6FF5zfmGQnypdXCbQJqHEJW5RJmKfj8nvgc'; $params = [ 'publicKey' => $publicKey, 'amount' => 200, 'billId' => 'cc961e8d-d4d6-4f02-b737-2297e51fb48e', 'successUrl' => 'http://test.ru/', ]; /** @var \Qiwi\Api\BillPayments $billPayments */ $link = $billPayments->createPaymentForm($params); echo $link; ?> https://oplata.qiwi.com/create?publicKey=2tbp1WQvsgQeziGY9vTLe9vDZNg7tmCymb4Lh6STQokqKrpCC6qrUUKEDZAJ7mvFnzr1yTebUiQaBLDnebLMMxL8nc6FF5zfmGQnypdXCbQJqHEJW5RJmKfj8nvgc&amount=200&billId=cc961e8d-d4d6-4f02-b737-2297e51fb48e&successUrl=http%3A%2F%2Ftest.ru%2F Надежный способ для интеграции. Параметры передаются server2server с использованием авторизации. Метод позволяет выставить счет, при успешном выполнении запроса в ответе вернется параметр payUrl — ссылка для редиректа пользователя на платежную форму.
Метод createBill выставляет новый счет. В параметрах нужно указать: идентификатор счета billId внутри вашей системы и дополнительными параметрами fields . В результате будет получен ответ с данными о выставленном счете.
Подробное описание параметров для выставления счёта представлено в руководстве по использованию SDK, а так же в документации для физ.лиц и для юр. лиц
$billId = 'cc961e8d-d4d6-4f02-b737-2297e51fb48e'; $fields = [ 'amount' => 1.00, 'currency' => 'RUB', 'comment' => 'test', 'expirationDateTime' => '2018-03-02T08:44:07+03:00', 'email' => 'example@mail.org', 'account' => 'client4563', ]; /** @var \Qiwi\Api\BillPayments $billPayments */ $response = $billPayments->createBill($billId, $fields); print_r($response); ?> Array ( [siteId] => 270305 [billId] => cc961e8d-d4d6-4f02-b737-2297e51fb48e [amount] => Array ( [currency] => RUB [value] => 200.34 ) [status] => Array ( [value] => WAITING [changedDateTime] => 2018-07-12T10:28:38.855+03:00 ) [comment] => test [creationDateTime] => 2018-07-12T10:28:38.855+03:00 [expirationDateTime] => 2018-08-26T10:28:38.855+03:00 [payUrl] => https://oplata.qiwi.com/form/?invoice_uid=cc961e8d-d4d6-4f02-b737-2297e51fb48e&successUrl=http%3A%2F%2Ftest.ru%2F ) Метод getBillInfo возвращает информацию о счете. В параметрах нужно указать идентификатор счета billId внутри вашей системы, в результате будет получен ответ со статусом счета. Подробнее в документации — для физ.лиц, для юр.лиц.
$billId = 'cc961e8d-d4d6-4f02-b737-2297e51fb48e'; /** @var \Qiwi\Api\BillPayments $billPayments */ $response = $billPayments->getBillInfo($billId); print_r($response); ?> Array ( [siteId] => 270305 [billId] => cc961e8d-d4d6-4f02-b737-2297e51fb48e [amount] => Array ( [currency] => RUB [value] => 200.34 ) [status] => Array ( [value] => WAITING [changedDateTime] => 2018-07-12T10:31:06.846+03:00 ) [comment] => test [creationDateTime] => 2018-07-12T10:31:06.846+03:00 [expirationDateTime] => 2018-08-26T10:31:06.846+03:00 [payUrl] => https://oplata.qiwi.com/form/?invoice_uid=cc961e8d-d4d6-4f02-b737-2297e51fb48e ) Отмена неоплаченного счета
Метод cancelBill отменяет неоплаченный счет. В параметрах нужно указать идентификатор счета billId внутри вашей системы, в результате будет получен ответ с информацией о счете. Подробнее в документации — для физ.лиц, для юр.лиц.
$billId = 'cc961e8d-d4d6-4f02-b737-2297e51fb48e'; /** @var \Qiwi\Api\BillPayments $billPayments */ $response = $billPayments->cancelBill($billId); print_r($response); ?> Array ( [siteId] => 270305 [billId] => cc961e8d-d4d6-4f02-b737-2297e51fb48e [amount] => Array ( [currency] => RUB [value] => 200.34 ) [status] => Array ( [value] => REJECTED [changedDateTime] => 2018-07-12T10:32:17.595+03:00 ) [comment] => test [creationDateTime] => 2018-07-12T10:32:17.481+03:00 [expirationDateTime] => 2018-08-26T10:32:17.481+03:00 [payUrl] => https://oplata.qiwi.com/form/?invoice_uid=cc961e8d-d4d6-4f02-b737-2297e51fb48e ) ! Метод недоступен для физических лиц
Методом refund производит возврат средств. В параметрах нужно указать идентификатор счета billId , идентификатор возврата refundId внутри вашей системы, сумму возврата amount и валюту возврата currency . Подробнее в документации.
$billId = 'cc961e8d-d4d6-4f02-b737-2297e51fb48e'; $refundId = '899343443'; $amount = 12; $currency = 'RUB'; /** @var \Qiwi\Api\BillPayments $billPayments */ $response = $billPayments->refund($billId, $refundId, $amount, $currency); print_r($response); ?> В результате будет выведена информация о возврате и о счете:
Array ( [amount] => Array ( [currency] => RUB [value] => 0.01 ) [dateTime] => 2018-07-12T10:34:02.191+03:00 [refundId] => 1531380841742 [status] => PARTIAL ) ! Метод недоступен для физических лиц
Метод getRefundInfo запрашивает статус возврата, в параметрах нужно указать идентификатор счета billId , идентификатор возврата refundId внутри вашей системы. Подробнее в документации.
$billId = 'cc961e8d-d4d6-4f02-b737-2297e51fb48e'; $refundId = '899343443'; /** @var \Qiwi\Api\BillPayments $billPayments */ $response = $billPayments->getRefundInfo($billId, $refundId); print_r($response); ?> В результате будет выведена информация о возврате:
Array ( [amount] => Array ( [currency] => RUB [value] => 1.00 ) [dateTime] => 2018-07-11T15:06:55.987+03:00 [refundId] => 1520425084283 [status] => PARTIAL ) - Метод generateId возвращает строку в формате UUID v4, удобно для генерирования billId , refundId :
/** @var \Qiwi\Api\BillPayments $billPayments */ $billId = $billPayments->generateId(); //e9b47ee9-b2f9-4b45-9438-52370670e2a6 ?> - Метод getLifetimeByDay генерирует дату до которой счет будет доступен для оплаты — lifetime . Входной параметр — сколько дней счет будет доступен, если не указанно, то по умолчанию 45 дней. Метод возвращает строку в формате ISO 8601 UTC±0:00:
//now: 2018-02-04T17:16:58.033Z /** @var \Qiwi\Api\BillPayments $billPayments */ $lifetime = $billPayments->getLifetimeByDay(1); //2018-02-05T17:16:58.033Z ?> //now: 2018-02-04T17:16:58.033Z /** @var \Qiwi\Api\BillPayments $billPayments */ $lifetime = $billPayments->getLifetimeByDay(0.5); //2018-02-05T05:16:58.033Z ?> - Метод checkNotificationSignature осуществляет проверку подписи при нотификации о новом счете от сервера уведомлений QIWI. Принимает на вход подпись из входящего запроса, объект — тело запроса и secret ключ, с помощью которого должна осуществляться подпись:
$validSignatureFromNotificationServer = '07e0ebb10916d97760c196034105d010607a6c6b7d72bfa1c3451448ac484a3b'; $notificationData = [ 'bill' => [ 'siteId' => 'test', 'billId' => 'cc961e8d-d4d6-4f02-b737-2297e51fb48e', 'amount' => ['value' => 1, 'currency' => 'RUB'], 'status' => ['value' => 'PAID'] ], 'version' => '3' ]; $secretKey = 'eyJ2ZXJzaW9uIjoicmVzdF92MyIsImRhdGEiOnsibWVyY2hhbnRfaWQiOjUyNjgxMiwiYXBpX3VzZXJfaWQiOjcxNjI2MTk3LCJzZWNyZXQiOiJmZjBiZmJiM2UxYzc0MjY3YjIyZDIzOGYzMDBkNDhlYjhiNTnONPININONPN090MTg5Z**********************'; /** @var \Qiwi\Api\BillPayments $billPayments */ $billPayments->checkNotificationSignature( $validSignatureFromNotificationServer, $notificationData, $secretKey ); // true ?> /** @var array $bill */ /** @var \Qiwi\Api\BillPayments $billPayments */ $payUrl = $billPayments->getPayUrl($bill, 'http://test.ru/'); // https://oplata.qiwi.com/form/?invoice_uid=d875277b-6f0f-445d-8a83-f62c7c07be77&successUrl=http%3A%2F%2Ftest.ru%2F ?> Текстирования с реальным API требует наличие файла tests/config.php заполненного по примеру из файла tests/config.sample.php . Для этого вам понадобится секретный ключ магазина.
cd bill-payments-php-sdk composer install --dev composer run test
Тестирования без истользования реального API:
cd bill-payments-php-sdk composer install --dev composer run util