added orderTimeout example

Author: payuru

example.php

@@ -38,12 +38,14 @@
             case 'paymentByToken':
             case 'paymentCapture':
             case 'paymentGetStatus':
+            case 'payoutCreate':
             case 'paymentWebhook':
             case 'paymentRefund':
             case 'paymentRefundMarketplace':
             case 'returnPage':
-                include './src/Examples/start.php';
-                include './src/Examples/'.$_GET['function'] . '.php';
+                require './src/Examples/start.php';
+                @include './src/Examples/'.$_GET['function'] . '__prepend.php';
+                require './src/Examples/'.$_GET['function'] . '.php';
                 break;
 
             default:

example_header.php

@@ -88,7 +88,8 @@
                         'text' => $examples[ $_GET['function'] ]['about'] . '
                             <br>
                             <br>
-                            <a target="_blank" href="https://github.com/yourpayments/php-api-client/blob/main/src/Examples/'. $_GET['function'] .'.php" class="alert-link">Адрес этого примера на Github</a> 
+                            <a class="btn btn-outline-success mr-3" target="_blank" href="https://github.com/yourpayments/php-api-client/blob/main/src/Examples/'. $_GET['function'] .'.php" class="alert-link">Адрес этого примера на Github</a>
+                            '.( !$examples[ $_GET['function'] ]['docLink'] ? '' : '<a class="btn btn-outline-success m-3" target="_blank" href="'.$examples[ $_GET['function'] ]['docLink'].'" class="alert-link">Документация API</a>' ).'
                         ',
                     ]);
                 }

example_list.php

@@ -17,11 +17,13 @@
     'simpleGetPaymentLink' => [
         'name'  => 'Самая простая кнопка оплаты',
         'about'  => 'В этом примере показана самая простая реализация. С минимальным набором полей без детализации, просто оплата заказа c определённой суммой.',
+        'docLink'  => 'https://secure.ypmn.ru/docs/#tag/Payment-API/paths/~1v4~1payments~1authorize/post',
         'link'  => '',
     ],
     'getPaymentLink' => [
         'name'  => 'Платёж со всеми подробностями',
         'about'  => 'Это пример платежа с максимальным набором полей.',
+        'docLink'  => 'https://secure.ypmn.ru/docs/#tag/Payment-API/paths/~1v4~1payments~1authorize/post',
         'link'  => '',
     ],
     'getPaymentLinkMarketplace' => [
@@ -32,31 +34,43 @@
     'getToken' => [
         'name'  => 'Создание токена',
         'about'  => 'Приложение передаёт номер успешно оплаченного заказа в YPMN API, и получает в ответ платёжный токен',
+        'docLink'  => 'https://secure.ypmn.ru/docs/#tag/Token-API/paths/~1v4~1token/post',
         'link'  => '',
     ],
     'paymentByToken' => [
         'name'  => 'Оплата токеном',
         'about'  => 'Оплата с помощью токена (теперь не нужно повторно вводить данные банковской карты)',
+        'docLink'  => 'https://secure.ypmn.ru/docs/#tag/Payment-API/paths/~1v4~1payments~1authorize/post',
         'link'  => '',
     ],
     'paymentCapture' => [
         'name'  => 'Списание средств',
         'about'  => 'Списание ранее заблокированной на счету суммы. Не обязательно, если у Вас настроена оплата в 1 шаг.',
+        'docLink'  => 'https://secure.ypmn.ru/docs/#tag/Payment-API/paths/~1v4~1payments~1capture/post',
         'link'  => '',
     ],
     'paymentRefund' => [
         'name'  => 'Возврат средств',
         'about'  => 'Запрос на полный или частичный возврат средств.',
+        'docLink'  => 'https://secure.ypmn.ru/docs/#tag/Payment-API/paths/~1v4~1payments~1refund/post',
         'link'  => '',
     ],
     'paymentRefundMarketplace' => [
         'name'  => 'Возврат средств со сплитом',
         'about'  => 'Запрос на полный или частичный возврат средств с разделением на несколько получателей.',
+        'docLink'  => 'https://secure.ypmn.ru/docs/#tag/Payment-API/paths/~1v4~1payments~1refund/posts',
         'link'  => '',
     ],
     'paymentGetStatus' => [
         'name'  => 'Проверка статуса платежа',
         'about'  => 'Запрос к YPMN API о состоянии платежа.',
+        'docLink'  => 'https://secure.ypmn.ru/docs/#tag/Payment-API/paths/~1v4~1payments~1status~1{merchantPaymentReference}/get',
+        'link'  => '',
+    ],
+    'payoutCreate' => [
+        'name'  => 'Создание выплаты',
+        'about'  => 'Запрос к YPMN для совершения выплаты на карту. У вас должно быть достаточно средств на специальном счету для выплат.',
+        'docLink'  => 'https://secure.ypmn.ru/docs/#tag/Payouts-API',
         'link'  => '',
     ],
     'returnPage' => [

src/Amount.php

@@ -0,0 +1,62 @@
+<?php declare(strict_types=1);
+
+namespace Ypmn;
+
+/**
+ * Это класс Баланса (сколько + валюта)
+ **/
+class Amount implements AmountInterface
+{
+    private float $value;
+    private string $currency = 'RUB';
+
+    /** @throws PaymentException */
+    public function __construct(float $value, $currency='RUB')
+    {
+        $this->setValue($value);
+
+        $this->setCurrency($currency);
+    }
+
+    /** @inheritdoc */
+    public function getValue(): float
+    {
+        return $this->value;
+    }
+
+    /** @inheritdoc
+     */
+    public function setValue(float $value): self
+    {
+        if ($value < 1) {
+            throw new PaymentException('Слишком маленькая выплата');
+        }
+
+        $this->value = $value;
+
+        return $this;
+    }
+
+    /** @inheritdoc */
+    public function getCurrency(): string
+    {
+        return $this->currency;
+    }
+
+    /** @inheritdoc */
+    public function setCurrency(string $currency): self
+    {
+        $this->currency = $currency;
+
+        return $this;
+    }
+
+    /** @inheritdoc */
+    public function arraySerialize() : array
+    {
+        return [
+            "currency" => $this->getCurrency() ?? 'RUB',
+            "value" => $this->getValue()
+        ];
+    }
+}

src/AmountInterface.php

@@ -0,0 +1,37 @@
+<?php declare(strict_types=1);
+
+namespace Ypmn;
+
+interface AmountInterface
+{
+
+    /**
+     * @return float
+     */
+    public function getValue(): float;
+
+
+    /**
+     * @param float $value
+     * @return Amount
+     * @throws PaymentException
+     */
+    public function setValue(float $value): self;
+
+    /**
+     * @return string
+     */
+    public function getCurrency(): string;
+
+    /**
+     * @param string $currency
+     * @return Amount
+     */
+    public function setCurrency(string $currency): self;
+
+
+
+
+
+
+}

src/ApiRequest.php

@@ -16,13 +16,15 @@ class ApiRequest implements ApiRequestInterface
     const TOKEN_API = '/api/v4/token';
     const REFUND_API = '/api/v4/payments/refund';
     const STATUS_API = '/api/v4/payments/status';
+    const PAYOUT_CREATE_API = '/api/v4/payout';
     const HOST = 'https://secure.ypmn.ru';
     const SANDBOX_HOST = 'https://sandbox.ypmn.ru';
 
+
     /** @var MerchantInterface Мерчант, от имени которого отправляется запрос */
     private MerchantInterface $merchant;
 
-    /** @var bool Режим Песочницы (тестовая панель Ypmn */
+    /** @var bool Режим Песочницы (тестовая панель Ypmn) */
     private bool $sandboxModeIsOn = false;
 
     /** @var bool Режим Отладки (вывод системных сообщений) */
@@ -251,6 +253,11 @@ public function sendTokenPaymentRequest(MerchantToken $tokenHash): array
         return $this->sendPostRequest($tokenHash, self::AUTHORIZE_API);
     }
 
+    public function sendPayoutCreateRequest(PayoutInterface $payout)
+    {
+        return $this->sendPostRequest($payout, self::PAYOUT_CREATE_API);
+    }
+
     /**
      * Подпись запроса
      * @param MerchantInterface $merchant Мерчант
@@ -321,4 +328,5 @@ class="w-100 d-block"
                 >'.print_r($mixedInput, true).'</pre>';
         }
     }
+
 }

src/Billing.php

@@ -4,10 +4,13 @@
 
 class Billing implements BillingInterface
 {
+    /** @var string Тип */
+    private string $type = 'individual';
+
     /** @var string Имя */
     private string $firstName;
 
-    /** @var string Фамилия */
+    /** @var ?string Фамилия */
     private string $lastName;
 
     /** @var string Email */
@@ -212,4 +215,18 @@ public function getIdentityDocument(): ?IdentityDocumentInterface
     {
         return $this->identityDocument ?? null;
     }
+
+    /** @inheritdoc */
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    /** @inheritdoc */
+    public function setType(string $type): self
+    {
+        $this->type = $type;
+
+        return $this;
+    }
 }

src/BillingInterface.php

@@ -172,4 +172,19 @@ public function setIdentityDocument(IdentityDocumentInterface $identityDocument)
      * @return null|IdentityDocumentInterface Удостоверение Личности
      */
     public function getIdentityDocument(): ?IdentityDocumentInterface;
+
+
+    /**
+     * Получить тип биллинга
+     * @return string
+     */
+    public function getType(): string;
+
+    /**
+     * Установить тип биллинга
+     * @param string $type
+     * @return Billing
+     */
+    public function setType(string $type): self;
+
 }

src/CardDetails.php

@@ -46,7 +46,9 @@ public function getNumber(): string
     /** @inheritDoc */
     public function setNumber(string $number): self
     {
+        //TODO: проверка на валидность
         $this->number = $number;
+
         return $this;
     }
 

src/Examples/payoutCreate.php

@@ -0,0 +1,81 @@
+<?php declare(strict_types=1);
+
+use Ypmn\Amount;
+use Ypmn\ApiRequest;
+use Ypmn\Billing;
+use Ypmn\Payout;
+use Ypmn\PayoutDestination;
+use Ypmn\PayoutSource;
+
+// Подключим файл, в котором заданы параметры мерчанта
+include_once 'start.php';
+
+/**
+ * Это файл с примером для создания выплат на карту физ. лицам
+ **/
+
+// Созданим выплату
+$payout = new Payout();
+
+// Назначим ей уникальный номер выплаты
+// (повторно этот номер использовать нельзя,
+// даже если выплата неудачная
+$payout->setMerchantPayoutReference('payout__' . time());
+
+// Назначим сумму
+$payout->setAmount(
+    new Amount(15, 'RUB')
+);
+
+// Назначим Описание
+$payout->setDescription('Тестовое Описание Платежа');
+
+// Опишем и назначим Направление и Получателя платежа
+$destination = new PayoutDestination();
+// Назначим номер карты
+$destination->setCardNumber("4111111111111111");
+// Опишем получателя
+$recipient = new Billing();
+// E-mail получателя
+$recipient->setEmail('[email protected]');
+// Город получателя
+$recipient->setCity('Москва');
+// Адрес получателя
+$recipient->setAddressLine1('Арбат, 10');
+// Почтовый индекс получателя
+$recipient->setZipCode('121000');
+// Код страны получателя (2 буквы, на английском)
+$recipient->setCountryCode('RU');
+
+// Имя получателя из GET-запроса
+$postRecipientName = explode(' ', @$_POST['reciever-name'] ?: '');
+// Установим Имя получателя для платежа
+$recipient->setFirstName(@$postRecipientName[0] ?: 'Иван');
+// Фамилия получателя
+$recipient->setLastName(@$postRecipientName[1] ?: @$postRecipientName[0] ?: 'Иванович');
+$destination->setRecipient($recipient);
+$payout->setDestination($destination);
+
+// Опишем и назначим Источник платежа
+$source = new PayoutSource();
+// Опишем отправителя
+$sender = new Billing();
+// Имя отправителя
+$sender->setFirstName('Василий');
+// Фамилия отправителя
+$sender->setLastName('Петрович');
+// Телефон отправителя
+$sender->setPhone('0764111111');
+// Email отправителя
+$sender->setEmail('[email protected]');;
+$source->setSender($sender);
+$payout->setSource($source);
+
+// Создадим HTTP-запрос к API
+$apiRequest = new ApiRequest($merchant);
+// Включить режим отладки (закомментируйте или удалите в рабочей программе!)
+$apiRequest->setDebugMode();
+// Переключиться на тестовый сервер (закомментируйте или удалите в рабочей программе!)
+$apiRequest->setSandboxMode();
+// Отправим запрос
+$responseData = $apiRequest->sendPayoutCreateRequest($payout);