Skip to content

Commit 17032fc

Browse files
committed
docs update
1 parent a3b0b16 commit 17032fc

3 files changed

Lines changed: 21 additions & 17 deletions

File tree

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,30 +33,29 @@
3333

3434
Пример быстрого старта для приёма платежей:
3535
```php
36-
$merchant = new Merchant('MERCHANT_CODE', 'SECRET_KEY');
36+
$merchant = new Merchant('MERCHANT_CODE', 'SECRET_KEY'); // Коды подключения API
37+
$merchantPaymentReference = 123; // Номер заказа в вашей системе
3738
$billing = (new Billing)
38-
->setCountryCode('RU')
39-
->setFirstName('Иван')
40-
->setLastName('Петров')
41-
->setEmail('test1@ypmn.ru')
42-
->setPhone('+74996492009')
43-
->setCity('Москва');
39+
->setCountryCode('RU') // Страна Плательщика
40+
->setFirstName('Иван') // Имя Плательщика
41+
->setLastName('Петров') // Фамилия Плательщика
42+
->setEmail('test1@ypmn.ru') // Почта Плательщика
43+
->setPhone('+74996492009') // Телефон Плательщика
44+
->setCity('Москва'); // Город Плательщика
4445

45-
$client = (new Client)
46-
->setBilling($billing);
47-
46+
$client = (new Client)->setBilling($billing);
4847
$payment = (new Payment)
4948
->addProduct(new Product([
5049
'name' => 'Заказ №' . $merchantPaymentReference,
51-
'sku' => $merchantPaymentReference,
50+
'sku' => 'artikul_test',
5251
'unitPrice' => 20.42,
5352
'quantity' => 1,
5453
]));
5554
$payment_method = $_GET['method'] ?? PaymentMethods::CCVISAMC; // Определим платёжный метод
5655
$authorization = new Authorization($payment_method, true);
5756
$payment->setAuthorization($authorization);
5857
$payment->setMerchantPaymentReference($merchantPaymentReference);
59-
$payment->setReturnUrl('https://' . @$_SERVER['HTTP_HOST'] . '/php-api-client/?function=returnPage');
58+
$payment->setReturnUrl('https://' . $_SERVER['HTTP_HOST'] . '/php-api-client/?function=returnPage');
6059
$payment->setClient($client);
6160
$apiRequest = new ApiRequest($merchant);
6261
$responseData = $apiRequest->sendAuthRequest($payment, $merchant);
@@ -67,7 +66,7 @@ if (isset($responseData["paymentResult"])) {
6766
$qr = $responseData['paymentResult']['bankResponseDetails']['customBankNode']['qr'];
6867
}
6968

70-
// Выведем кнопку оплаты, рекомендуется
69+
// Выведем кнопку оплаты (рекомендуется)
7170
echo Std::drawYpmnButton([
7271
'qr' => ($qr ?? null),
7372
'url' => $responseData['paymentResult']['url'] ?? '',
@@ -87,7 +86,7 @@ if (isset($responseData["paymentResult"])) {
8786
- безопасность и точность расчётов
8887

8988
Библиотека содержит:
90-
- Клиент API
89+
- Клиент для работы с API платежей, выплат, отчётов
9190
- Простой встроенный сервер с примерами
9291
- Описание контейнера для запуска в Docker
9392

src/ApiRequest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ private function sendPostPutRequest(
368368
$curl = curl_init();
369369
$date = (new DateTime())->format(DateTimeInterface::ATOM);
370370

371-
$useragent = "SDK_" . @PHP_VERSION;
371+
$useragent = "SDK_PHP_" . @PHP_VERSION;
372372
$referer = @$_SERVER['HTTP_HOST'] ?? @$_SERVER['SERVER_NAME'] ?? "" . @$_SERVER['REQUEST_URI'] ?? "";
373373

374374
$setOptArray = [

src/Examples/returnPage.php

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
<?php
22
/**
3-
* Страница после оплаты.
4-
* Параметры передаются в $_GET или $_POST, в зависимости от настройки мерчанта в YPMN:
3+
* @deprecated Используйте новые параметры
4+
* `successUrl` после успешной оплаты
5+
* и `failUrl` после неудачной оплаты
6+
* https://ypmn.ru/doc/#tag/payment-api-return-url
7+
*
8+
* Ниже старая (единая) страница после оплаты.
9+
* В ней параметры передаются в $_GET или $_POST, в зависимости от настройки мерчанта в YPMN
510
*/
611
$statusResponseFromServer = (json_decode($_POST['body'] ?? '{}', true))['status'] ?? null;
712

0 commit comments

Comments
 (0)